Digital Logic modules for FPGA
Explore the docs »

View Demo · Report Bug · Request Feature

• About the Project
  • Built with
• Getting Started
  • Prerequisites
  • Installing
• Usage
• Roadmap

• Contributing
• License
• Contacts
• Support the Project
• Acknowledgements

Description of the project and it's intended purpose or origin story.

• MkDocs documentation generator

• pip3

  $ sudo apt-get install python3-pip

• MkDocs

  $ pip3 install -U mkdocs

  Make sure ~/.local/bin is added to your PATH

• MkPDF-MkDocs Plugin

  $ pip3 install git+https://github.com/jwaschkau/mkpdfs-mkdocs-plugin.git#egg=mkpdfs-mkdocs-plugin

1. Clone the repo

   $ git clone https://github.com/Anatrax/MkDocsSetup.git

• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs gh-deploy - Deploy the documentation to GitHub Pages.
• mkdocs -h - Print help message and exit.

For more examples, please refer to the official MkDocs documentation.

For more information on customizing the PDF output, please refer to the official MkPDFs-MkDocs Plugin Documentation.

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

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

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

Distributed under the GNU Public License. See LICENSE for more information.

Maintainer: Samuel D. Villegas - [email protected]