Skip to content

Commit 33e21e1

Browse files
committed
Update quick start instructions and add README for documentation automation template
1 parent 71050fe commit 33e21e1

File tree

2 files changed

+69
-5
lines changed

2 files changed

+69
-5
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Documentation Automation Template
2+
3+
A template for automatically deploying documentation to GitHub Pages using GitHub Actions. This template uses Just the Docs theme and GitHub Actions for automated builds and deployments.
4+
5+
## Features
6+
7+
- 🚀 Automatic deployment to GitHub Pages
8+
- 📖 Modern documentation theme using Just the Docs
9+
- 🔍 Built-in search functionality
10+
- 📱 Mobile-responsive design
11+
- 🔄 CI/CD pipeline using GitHub Actions
12+
- 📝 Markdown-based content
13+
- 🎨 Customizable theme and styling
14+
15+
## Setup Steps
16+
17+
1. **Configure GitHub Pages**
18+
- Go to your repository's Settings
19+
- Navigate to "Pages" section
20+
- Under "Build and deployment", select "GitHub Actions" as the source
21+
22+
2. **Update Configuration**
23+
24+
Edit `docs/_config.yml` and update these key settings:
25+
```yaml
26+
# Replace with your repository name
27+
baseurl: "/your-repository-name"
28+
29+
# Replace with your GitHub Pages URL
30+
url: "https://your-username.github.io"
31+
32+
# Update repository link
33+
aux_links:
34+
"GitHub":
35+
- "https://github.com/your-username/your-repository"
36+
```
37+
38+
3. **Verify Deployment**
39+
- Make a small change to any file in the `docs` folder
40+
- Commit and push to the main branch
41+
- Go to Actions tab to watch the deployment
42+
- Once complete, your documentation will be available at:
43+
`https://your-username.github.io/your-repository-name/`
44+
45+
## Local Testing (Optional)
46+
47+
If you want to test locally before pushing:
48+
```bash
49+
cd docs
50+
bundle install
51+
bundle exec jekyll serve
52+
```
53+
Visit `http://localhost:4000/your-repository-name/`
54+
55+
## Documentation
56+
57+
Start adding your documentation in the `docs` folder using markdown files. Any push to the main branch will automatically trigger a new build and deployment.
58+
59+
---
60+
⭐️ If you find this template helpful, don't forget to star it!

docs/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,15 @@ This automation system allows you to:
1919

2020
## Quick Start
2121

22-
1. [Fork or clone this repository](https://github.com/SingularityNET-Archive/documentation-automation)
23-
2. Enable GitHub Pages in your repository settings
24-
3. Update `docs/_config.yml` with your repository information
25-
4. Add markdown files to the `docs` folder
26-
5. Push to main branch and watch your documentation deploy!
22+
1. [Template repo](https://github.com/new?template_name=documentation-automation&template_owner=SingularityNET-Archive)
23+
2. Enter Repo name, description and create repo
24+
3. Enable GitHub Pages in your repository settings
25+
- Go to your repository settings on GitHub
26+
- Navigate to the "Pages" section
27+
- Under "Source", select "GitHub Actions"
28+
4. Update `docs/_config.yml` with your repository information
29+
5. Add markdown files to the `docs` folder
30+
6. Push to main branch and watch your documentation deploy!
2731

2832
## Detailed Setup Guides
2933

0 commit comments

Comments
 (0)