https://github.com/sean-njela/docs
A preconfigured and fully customizable docs setup. Just clone and use.
https://github.com/sean-njela/docs
docs documentation mksocs read readme readthedocs
Last synced: 5 months ago
JSON representation
A preconfigured and fully customizable docs setup. Just clone and use.
- Host: GitHub
- URL: https://github.com/sean-njela/docs
- Owner: sean-njela
- License: mit
- Created: 2025-07-19T19:41:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-20T06:27:42.000Z (11 months ago)
- Last Synced: 2025-07-20T06:37:06.900Z (11 months ago)
- Topics: docs, documentation, mksocs, read, readme, readthedocs
- Homepage: https://sean-njela.github.io/docs/latest/0-index/
- Size: 854 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Project Title
Short description of the project. What it does, what problem it solves, or what it demonstrates.
## Screenshots
Click to expand
## Tech Stack
> List of tools used in the project
[](https://www.jetify.com/devbox/docs/contributor-quickstart/)
## Prerequisites
> [!IMPORTANT]
> This project uses **Devbox** to provide a consistent development environment.
1. **Install Docker**
[Docker installation guide](https://docs.docker.com/get-docker/)
2. **Install Devbox**
[Devbox installation guide](https://www.jetify.com/devbox/docs/installing_devbox/)
3. **Clone the repository**
```bash
git clone ...
cd ...
```
4. **Start Devbox shell**
```bash
devbox shell
```
> First run may take several minutes to install tools, but subsequent runs spin up in seconds.
## Quick Start
```bash
task setup
task status # check if everything is running
task dev # start development stack
task cleanup-dev
```
## Documentation
For full documentation, setup instructions, and architecture details, visit the [docs](docs/index.md) directory or run locally with:
```bash
task docs
```
Then open: [http://127.0.0.1:8030/]()
## Tasks (Automation)
> [!IMPORTANT]
> This project is designed for a simple, one-command setup. All necessary actions are orchestrated through `Taskfile.yml`.
The `Taskfile.gitflow.yml` provides a structured Git workflow using Git Flow. This helps in managing features, releases, and hotfixes in a standardized way. To run these tasks just its the same as running any other task. Using gitflow is optional. If you do not want the gitflow tasks, you can remove the `Taskfile.gitflow.yml` file and unlink it from the `Taskfile.yml` file (remove the `includes` section). If you cannot find the section use CTRL + F to search for `Taskfile.gitflow.yml`.
To see all tasks:
```bash
task --list-all
```
## Contributing
> Contributions welcome! Open an issue or submit a PR.
## License
Distributed under the MIT License. See `LICENSE` for more info.
## Contact
* [LinkedIn](https://linkedin.com/in/sean-njela)
* [Twitter/X](https://x.com/devopssean)
* [seannjela@outlook.com](mailto:seannjela@outlook.com)
* [About Me](docs/4-about/0-about.md)