Platen

A toolkit providing scaffolding of digital tabletop gaming tools and other interactive web books. Platen shortens the distance between creators and digital versions of their texts that are accessible, interactive, responsive, and---above all---delightful to author and maintain.
Explore the docs »

Get Started with Platen »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

Platen is a collection of Hugo modules, tools, and guides for helping tabletop game authors digital editions of their works as incredible as their physical editions. With Platen, you can write your games in Markdown and

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

Platen relies on the extended version of Hugo. For more information, see Hugo's notes. For full installation instructions, see Hugo's documentation.

Installation

You can add Platen to your Hugo site as a module.

Start with initializing hugo modules, if not done yet:

hugo mod init github.com/repo/path

Navigate to your hugo project root and add [module] section to your config.yaml:

module:
  imports:
    - path: github.com/platenio/platen/modules/platen

Then, to load/update the theme module and run hugo:

hugo mod get -u
hugo server --minify

(back to top)

Roadmap

• Write getting started guide
  • Document shortcodes
  • Schematize configuration
  • Document configuration
• Write user handbook
  • Document styles
  • Document customization
  • Document Front Matter usage
  • Document suggested practices
• Write module developer guide
• Write contributor guide

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repository and create a pull request. You can also open an issue with the tag enhancement. Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/main/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/main/AmazingFeature)
5. Open a Pull Request

(back to top)

License

The code in this project is distributed under the MIT License. The documentation and other non-code files are licensed CC-BY.

(back to top)

Contact

Find me on twitter @BigFnMikey.

(back to top)

Acknowledgments

• Forked with 💜 from hugo-book by Alex Shpak.

(back to top)