https://github.com/avdata99/testing-mkdocs-multilang-template
Testing the new template
https://github.com/avdata99/testing-mkdocs-multilang-template
Last synced: about 2 months ago
JSON representation
Testing the new template
- Host: GitHub
- URL: https://github.com/avdata99/testing-mkdocs-multilang-template
- Owner: avdata99
- License: mit
- Created: 2022-09-09T18:06:04.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-09T19:29:55.000Z (almost 4 years ago)
- Last Synced: 2025-01-26T00:11:34.314Z (over 1 year ago)
- Language: HTML
- Size: 712 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs Test site
Static site generator with [mkdocs](https://www.mkdocs.org).
PDF built with [mkdocs-with-pdf](https://github.com/orzih/mkdocs-with-pdf).
Public URL: https://avdata99.github.io/test-mkdocs/
PDF version: https://avdata99.github.io/test-mkdocs/pdf/doc.pdf
## Build & Deploy
Using the [deploy-mkdocs](https://github.com/marketplace/actions/deploy-mkdocs)
GitHub action a public html site will be built.
## Features
The `docs` folder include markdown files that will be built as a html site and a PDF document.
It's also possible to include static files.
The `mkdocs.yml` file allows you to define all the site and PDF settings.
The `pdf-template` folder include the cover and back-cover html files that will be used only in the PDF version. It's also posible to define custom CSS style for the PDF version with the `styles.scss` file.
Translations are [availabe](https://www.mkdocs.org/dev-guide/translations/) for mkdocs.