This template repository is made to jumpstart the creation of a documentation site for any type of project.
It uses Material Theme for MkDocs, to render an awesome-looking site that can be easely edited using any markdown-compatible text editor, even with the native Markdown editor of Github itself!.
For full documentation about the components of this repo, visit mkdocs.org, mkdocs-material, drawio, mkdocs-drawio-file, mkdocs-git-revision-date-localized-plugin and mkdocs-git-authors-plugin.
- Install he dependancies of this project.
FIRST:
npm install
OR
yarn install
OR
bun install
AND THEN:
pip install -r requirements.txt
- Start the live-reloading docs server.
mkdocs serve
OR
npm run serve
- Build the documentation site.
mkdocs build
OR
npm run build
- Make automatic Release, using the conventional commits to generate a CHANGELOG (ensure to this after the workflow CI finish to generate the .png files from the drawio files).
npm run release-it
.github/ # GitHub related files (README, Issue Templates, Actions, etc).
.husky/commit-msg # Configuration file to handle the commit msg for commitlint.
.gitattributes # Git Configuration file to handle various types of files.
.gitignore # Git Configuration file for git to ignore files or folders.
package.json # Manage node.js dependencies, scripts, versioning, config and modules.
requeriments.txt # pip requeriments files to handle python dependencies.
mkdocs.yml # The configuration file.
docs/ # Main folder for the documentation, each sub-directory will be a section
index.md # The documentation homepage.
assets/ # Assets for the documentation site (favicon, logo, drawio files, etc).
stylesheets/ # Stylesheets to add custom color palettes.
extra.css # Sample on an stylesheet to override the theme.
drawio-assets/ # Redered versions of the diagram in the drawio files (.png images by default).
sample/ # Sample section.
sample-section.md # Main markdown of a sample section.
... # Other markdown pages, images and other files.