https://github.com/balnarendrasapa/docusaurus_site
Build documentation site for your project. Directly convert your markdown and jupyter notebooks to webpages rendered by docusaurus site using github actions
https://github.com/balnarendrasapa/docusaurus_site
documentation jupyter-notebook markdown python
Last synced: 2 months ago
JSON representation
Build documentation site for your project. Directly convert your markdown and jupyter notebooks to webpages rendered by docusaurus site using github actions
- Host: GitHub
- URL: https://github.com/balnarendrasapa/docusaurus_site
- Owner: balnarendrasapa
- License: apache-2.0
- Created: 2023-08-07T20:37:09.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-15T19:54:05.000Z (almost 3 years ago)
- Last Synced: 2025-06-14T02:09:24.778Z (about 1 year ago)
- Topics: documentation, jupyter-notebook, markdown, python
- Homepage: https://balnarendrasapa.github.io/docusaurus_site/docs/intro
- Size: 1.71 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📚 Docusaurus Template Site
Generate a documentation site for your Python or any other project involving Jupyter notebooks effortlessly using this repository template.
## 🚀 Getting Started
1. **Fork this repository** to your own GitHub account.
2. **Make necessary changes:**
- Modify names in `settings.ini` and `docusaurus.config.js` files in the `docs_skeleton` directory.
3. **Enable GitHub Pages deployment:**
- Go to the repository settings.
- Under "Pages" in repository settings, select "GitHub Actions Beta" under "Build and Deployment".
4. **Workflow Automation:**
- This repository includes a workflow.
- Place your files in respective directories.
- Merge your changes with the `master` branch.
- The workflow will be triggered automatically, and your GitHub site will be built and deployed.
5. **Add Content:**
- Place your markdown and Jupyter notebook files in the `files` directory within the `docs` directory.
- You can create sub-directories to group Markdown or notebook files, which will add a dropdown list on the site.
## 📦 Dependencies
This project makes use of the following repositories:
1. [Docusaurus](https://github.com/facebook/docusaurus)
2. [nbdocs](https://github.com/outerbounds/nbdoc)
## 🌐 Example Site
Check out the generated site: [Demo Site](https://balnarendrasapa.github.io/docusaurus_site/docs/intro)
## 📖 Documentation
For detailed instructions and customization options, refer to the official Docusaurus documentation.
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.