Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decentsoftware-eu/decentholograms-wiki
https://github.com/decentsoftware-eu/decentholograms-wiki
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/decentsoftware-eu/decentholograms-wiki
- Owner: DecentSoftware-eu
- License: gpl-3.0
- Created: 2021-11-29T21:26:38.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-09T18:12:35.000Z (about 1 month ago)
- Last Synced: 2024-11-09T19:21:21.645Z (about 1 month ago)
- Language: HTML
- Size: 4.24 MB
- Stars: 0
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DecentHolograms Wiki
This repository is the home of the [DecentHolograms Wiki][wiki].
It is build using [MkDocs][mkdocs] and the [Material for MkDocs theme][material].
## 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][material] 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.
[wiki]: https://wiki.decentholograms.eu
[mkdocs]: https://www.mkdocs.org
[material]: https://squidfunk.github.io/mkdocs-material