Skip to content

Latest commit

 

History

History
92 lines (77 loc) · 3.28 KB

README.md

File metadata and controls

92 lines (77 loc) · 3.28 KB
Raw

DecentHolograms Wiki

This repository is the home of the DecentHolograms Wiki.

It is build using MkDocs and the Material for MkDocs theme.

Repository Structure

Directories with ... indicate multiple (more than one) files.

.
├── .github/
│   └── workflows/
│       └── publish_site.yml
├── docs/
│   ├── api/
│   │   └── ...
│   ├── assets/
│   │   ├── images/
│   │   │   ├── favicons/
│   │   │   │   └── ...
│   │   │   ├── format/
│   │   │   │   └── line_types.png
│   │   │   └── setup/
│   │   │       └── ...
│   │   ├── js/
│   │   │   └── github-release.js
│   │   ├── stylesheets/
│   │   │   └── theme.css
│   │   └── site.webmanifest
│   ├── general/
│   │   ├── commands/
│   │   │   └── ...
│   │   ├── configuration/
│   │   │   └── ...
│   │   ├── examples/
│   │   │   └── ...
│   │   ├── format-and-colors/
│   │   │   └── ...
│   │   └── ...
│   └── ...
├── hooks/
│   └── CommandLexer/
│       ├── commandlexer/
│       │   └── ...
│       └── setup.py
├── theme/
│   ├── partials/
│   │   └── ...
│   └── ...
├── .gitignore
├── LICENSE
├── mkdocs.yml
├── README.md
└── requirements.txt

Important files/folders

  • docs is the main directory containing the markdown files that get rendered into static HTML pages by MkDocs for the wiki.
  • hooks contains the custom CommandLexer used for Pygments to allow the custom code highlighting for the different /dh ... commands on the wiki.
  • theme contains overrides for the Material for MkDocs theme to customize some of its main behaviour (i.e. generating a page title and subtitle).
  • mkdocs.yml contains the configuration used by MkDocs. This includes the theme, plugins and extensions used.
  • requirements.txt contains the necessary dependencies that need to be installed during page publication. Note that MkDocs and PyMDown Extensions are included within Material for MkDocs when installing.

Contribute

Feel free to contribute to this repository. All kinds of contributions no matter how big or small are welcomed.
Just make sure to follow the below steps to have everything prepared to work on and test stuff.

Prerequisite

  • Python 3.11 or newer
  • Pip (For dependency installing)
  • Git (For repo cloning)

Steps

  • Fork this repository using the "Fork" button at the top
  • On your PC, choose a folder where to clone your repository in, open Git bash and clone your fork
  • cd into your fork
  • Run pip install -r requirements.txt to install the necessary dependencies
  • Use mkdocs serve to start a live-preview of the docs to look at.
  • Start working

Once you're done with your changes, commit and push them to your fork and make a PR to the upstream (This) repository.
If everything looks good will your changes be merged and the wiki updated.