|
1 | | -# Documentation Site |
| 1 | +# docs.bytelabs.uk |
2 | 2 |
|
3 | 3 | A basic documentation site built with Jekyll and configured for Read the Docs. |
4 | | - |
5 | | -## Features |
6 | | - |
7 | | -- **Jekyll** for static site generation |
8 | | -- **Read the Docs** compatibility |
9 | | -- **GitHub Pages** support |
10 | | -- **Markdown** documentation |
11 | | -- **Responsive design** |
12 | | - |
13 | | -## Quick Start |
14 | | - |
15 | | -1. Clone this repository |
16 | | -2. Install dependencies: `bundle install` |
17 | | -3. Run locally: `bundle exec jekyll serve` |
18 | | -4. Visit `http://localhost:4000` |
19 | | - |
20 | | -## Deployment |
21 | | - |
22 | | -### Read the Docs |
23 | | - |
24 | | -1. Connect your GitHub repository to Read the Docs |
25 | | -2. Configure your `.readthedocs.yaml` file |
26 | | -3. Push changes to trigger builds |
27 | | - |
28 | | -### GitHub Pages |
29 | | - |
30 | | -1. Enable GitHub Pages in your repository settings |
31 | | -2. Choose the source branch (usually `main` or `gh-pages`) |
32 | | -3. Push changes to trigger deployments |
33 | | - |
34 | | -## Documentation Structure |
35 | | - |
36 | | -``` |
37 | | -docs/ |
38 | | -├── index.md # Homepage |
39 | | -├── _docs/ # Documentation collection |
40 | | -│ ├── getting-started.md |
41 | | -│ ├── api.md |
42 | | -│ └── examples.md |
43 | | -├── _layouts/ # Jekyll layouts |
44 | | -│ └── default.html |
45 | | -├── _config.yml # Jekyll configuration |
46 | | -├── Gemfile # Ruby dependencies |
47 | | -└── .readthedocs.yaml # Read the Docs configuration |
48 | | -``` |
49 | | - |
50 | | -## Writing Documentation |
51 | | - |
52 | | -- Create new files in the `_docs` directory |
53 | | -- Use proper YAML front matter |
54 | | -- Follow Markdown syntax |
55 | | -- Link between documents using relative paths |
56 | | - |
57 | | -## Customization |
58 | | - |
59 | | -- Edit `_config.yml` to change site settings |
60 | | -- Modify `_layouts/default.html` to change the layout |
61 | | -- Add custom CSS in `assets/css/` |
62 | | -- Extend with Jekyll plugins as needed |
0 commit comments