Skip to content

Commit 3ac0a97

Browse files
authored
improved README.md (#6)
1 parent 9bf5f2d commit 3ac0a97

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,32 @@
1-
# Devsite to Hugo/Docsy Converter
1+
# Bazel Docs
22

3-
A Python utility that converts Google Devsite documentation to Hugo/Docsy format with dual GitHub Actions workflows for monitoring and site generation.
3+
Convert Bazel’s Devsite docs into a Hugo/Docsy site for easy modification.
44

5-
## Overview
5+
## Motivation
66

7-
This tool specifically converts the Bazel documentation from its source format at `https://github.com/bazelbuild/bazel/tree/master/site/en` to a Hugo static site using the Docsy theme. The conversion includes:
7+
This tool implements the improvements outlined in [Bazel Docs: Why It Might Be Time For A Refresh](https://alanmond.com/posts/bazel-documentation-improvements/). The goal is to create a more developer friendly set of Bazel Docs. Starting with [bazel.build/docs](https://bazel.build/docs)
88

9-
- Devsite-specific frontmatter to Hugo frontmatter conversion
10-
- Directory structure transformation for Hugo/Docsy compatibility
11-
- CSS/SCSS conversion for theme integration
12-
- Automated GitHub Actions workflows for continuous updates
13-
- Comprehensive validation and error handling
9+
## Live Demo
10+
11+
https\://bazel-docs-68tmf.ondigitalocean.app/
12+
13+
## How it works
14+
15+
1. Clones the Devsite source from `bazel.build/docs`.
16+
2. Transforms Devsite frontmatter and directory layout into Hugo/Docsy format.
17+
3. Converts CSS/SCSS for Docsy theme compatibility.
1418

1519
## Usage
20+
21+
Run the latest build locally:
22+
23+
```bash
24+
docker run -it -p 1313:1313 alan707/bazel-docs:latest
25+
```
26+
27+
Build a new image:
28+
29+
```bash
30+
docker build . -t bazel_docs:latest
31+
```
32+

0 commit comments

Comments
 (0)