Skip to content

Commit bf8ac2b

Browse files
benfalkbenfalk
committed
🎨 Fit and Finish
1 parent 57542ed commit bf8ac2b

16 files changed

Lines changed: 945 additions & 115 deletions

‎.github/workflows/documentation.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write # To push a branch
12+
pages: write # To push to a GitHub Pages site
13+
id-token: write # To update the deployment status
14+
steps:
15+
- uses: actions/checkout@v4
16+
with:
17+
fetch-depth: 0
18+
- uses: benfalk/mdbook-gh-pages@main
19+
- name: Build Book
20+
run: |
21+
mdbook build
22+
- name: Setup Pages
23+
uses: actions/configure-pages@v4
24+
- name: Upload artifact
25+
uses: actions/upload-pages-artifact@v3
26+
with:
27+
# Upload entire repository
28+
path: 'book'
29+
- name: Deploy to GitHub Pages
30+
id: deployment
31+
uses: actions/deploy-pages@v4

‎CHANGELOG.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable-file MD024 -->
12
# Changelog
23

34
All notable changes to this project will be documented in this file. The format
@@ -8,6 +9,19 @@ is based on [Keep a Changelog], and this project adheres to [Semantic Versioning
89

910
## [Unreleased]
1011

12+
🎨 Fit and finish for initial release with updated documentation.
13+
14+
### Added
15+
16+
- CI documentation job from master branch for GitHub Pages
17+
- `dev-book` recipe to build and serve documentation locally
18+
- `dev-setup` recipe and bootstrap script for local setup
19+
- `reqmd` CLI documentation with examples and usage instructions
20+
21+
### Changed
22+
23+
- Updated README with link to the online documentation
24+
1125
## [0.1.1] 2026-02-21
1226

1327
🚀 Initial release of ReqMD, a tool for parsing markdown files looking for code

‎Justfile‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@ dev-cli COMMAND *ARGS:
1616
dev-tui *ARGS:
1717
@cargo run -q --package reqmd_tui -- {{ARGS}}
1818

19+
# mdbook documentation with hot reloading
20+
[group('dev')]
21+
dev-book:
22+
mdbook serve -p 9033 --open
23+
24+
# Setup environment for development
25+
[group('dev')]
26+
[no-cd]
27+
dev-setup:
28+
@./scripts/setup-dev-environment.sh
29+
1930
# Builds all crates in the workspace
2031
[group('build')]
2132
build:
@@ -26,17 +37,17 @@ build:
2637
build-rust-docs:
2738
cargo doc --workspace --no-deps --open
2839

29-
# Builds and installs the CLI crate
40+
# Installs the CLI reqmd
3041
[group('build')]
3142
build-install-cli:
3243
@just _crate_install reqmd_cli
3344

34-
# Builds and installs experimental TUI crate
45+
# Installs experimental TUI reqmd_tui
3546
[group('build')]
3647
build-install-tui:
3748
@just _crate_install reqmd_tui
3849

39-
# runs all quick tests or specific functions
50+
# runs quick tests or specific functions
4051
[group('test')]
4152
test *TEST_CASES:
4253
@{{if TEST_CASES != "" { "just _run test-funcs " + TEST_CASES } \
@@ -48,7 +59,7 @@ test *TEST_CASES:
4859
test-docs:
4960
cargo test --doc
5061

51-
# test code comments generate documentation
62+
# souce comments documentation
5263
[group('test')]
5364
test-doc-gen:
5465
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# ReqMD: HTTP Requests in Markdown
22

3+
![Readable. Executable. Simple.](./docs/assets/mast-head.svg)
4+
35
This is a project focused on representing a human readable markdown
46
format which describes HTTP requests. The goal is to be able to create
5-
markdown documents using this specification and leverage this tooling
7+
markdown documents using that specification and leverage this tooling
68
to identify and send them as valid HTTP requests.
9+
10+
To get started [read the friendly manual].
11+
12+
[read the friendly manual]: https://benfalk.github.io/req_md/

‎book.toml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,12 @@
22
title = "ReqMD"
33
authors = ["Ben Falk"]
44
src = "docs"
5+
6+
[output.html]
7+
default-theme = "ayu"
8+
preferred-dark-theme = "ayu"
9+
git-repository-url = "https://github.com/benfalk/req_md"
10+
no-section-label = true
11+
fold = { enable = true, level = 0 }
12+
13+
[preprocessor.anchors-aweigh]

‎docs/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Index
1+
# 📒 ReqMd
2+
3+
![Readable. Executable. Simple.](./assets/mast-head.svg)
24

35
Welcome to the `ReqMd` documentation! These docs are aimed at explaining the
46
format specification, tools available, and structure of the codebase. The menu
@@ -8,7 +10,7 @@ the discussions] on Github with your question.
810

911
[post in the discussions]: https://github.com/benfalk/req_md/discussions/categories/q-a
1012

11-
## Inspiration
13+
## 🎇 Inspiration
1214

1315
While pair-programming in 2019 a colleague demonstrated [this fantastic VS Code
1416
plugin] which parsed HTTP requests in a special file format. These requests could

‎docs/SUMMARY.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# Summary
22

3-
[Index](./README.md)
3+
[📒 ReqMd](./README.md)
44

55
---
66

7-
- [ReqMd Markdown Format](./reqmd-format.md)
7+
- [📐 Markdown Format](./reqmd-format.md)
8+
- [🔎 Front Matter](./reqmd-format-front-matter.md)
9+
- [🌐 HTTP Requests](./reqmd-format-http-requests.md)
10+
- [🖥️ `reqmd` Terminal Application](./reqmd-terminal-app.md)
11+
- [📥 Install `reqmd`](./cli-installation-methods.md)
12+
- [🛠️ Development Setup](./development-setup.md)

‎docs/assets/mast-head.svg‎

Lines changed: 158 additions & 0 deletions
Loading

‎docs/assets/sample.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Working with Widgets
3+
http:
4+
server: https://echo.free.beeceptor.com
5+
---
6+
7+
## Create Widget
8+
9+
```http
10+
POST /widget
11+
Content-Type: application/json
12+
```
13+
14+
```json
15+
{ "name": "foo" }
16+
```
17+
18+
## Delete Widget
19+
20+
```http
21+
DELETE /widget/123
22+
```
23+
24+
## Search Widgets
25+
26+
```http
27+
GET /widget/search
28+
?q=full+metal
29+
&max=10
30+
```

0 commit comments

Comments
 (0)