https://github.com/emfcamp/badge-2024-documentation
Tildagon badge documentation website
https://github.com/emfcamp/badge-2024-documentation
Last synced: 5 months ago
JSON representation
Tildagon badge documentation website
- Host: GitHub
- URL: https://github.com/emfcamp/badge-2024-documentation
- Owner: emfcamp
- License: other
- Created: 2024-02-01T15:55:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-05T11:30:59.000Z (8 months ago)
- Last Synced: 2025-10-05T12:23:56.831Z (8 months ago)
- Language: Makefile
- Homepage: https://tildagon.badge.emfcamp.org/
- Size: 30.6 MB
- Stars: 21
- Watchers: 14
- Forks: 39
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/emfcamp/badge-2024-documentation/actions/workflows/ci.yml)
[](https://github.com/emfcamp/badge-2024-documentation/actions/workflows/check_links.yml)
[](https://github.com/emfcamp/badge-2024-documentation/actions/workflows/markdown-lint.yml)
[](https://github.com/emfcamp/badge-2024-documentation/actions/workflows/python-lint.yml)
# Tildagon Badge Documentation
This is the source for the [Tildagon Badge Documentation](https://tildagon.badge.emfcamp.org/).
Contributions are welcome!
## Testing the documentation on your computer
### Project Setup
Run these commands to set up a Python virtual environment and install the required packages for the project in the project folder:
```sh
pip install pipenv
pipenv install
```
You only need to run this command once.
To activate the virtual environment, run:
```sh
pipenv shell
```
If you open a new terminal window, navigate back to the project folder and activate the virtual environment again.
### Serve the docs locally
To serve the docs locally on your machine, run the following command:
```sh
mkdocs serve
```
### Generate HTML docs
To generate the full HTML version of the docs run:
```sh
make build-prod
```
You can serve the resulting docs with:
```sh
python3 -m http.server 9000 --directory public
```
### Linters
To run linters locally:
Install [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) and ensure you have run `pipenv install` and `pipenv activate`.
Then run the following commands to lint the markdown files and the python code snippets:
```sh
make lint-markdown
make lint-py
```
## Contribute to the documentation
Want to improve our documentation? Please do! You can [open a PR](https://docs.github.com/en/desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request-from-github-desktop) and we'll take a look.
Resources:
- [Style Guide](https://www.emfcamp.org/about/branding)