Skip to content

Commit 1e63940

Browse files
committed
docs: add mdBook-based documentation with GitHub Pages deployment
Add comprehensive documentation as an mdBook covering installation, features, customization, examples, and reference materials. Include GitHub Actions workflow for automatic deployment to GitHub Pages on push to master.
1 parent 4ef9f0e commit 1e63940

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+18976
-1
lines changed

.github/workflows/book-deploy.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Book
2+
3+
on:
4+
push:
5+
branches: ["feature/book"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
jobs:
14+
build-and-deploy:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
19+
20+
- name: Set up mdBook
21+
uses: peaceiris/actions-mdbook@ee69d230fe19748b7abf22df32acaa93833fad08 # v2.0.0
22+
with:
23+
mdbook-version: "0.5.2"
24+
25+
- name: Build Book
26+
run: mdbook build docs
27+
28+
- name: Setup Pages
29+
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
30+
31+
- name: Upload Artifact
32+
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
33+
with:
34+
path: "./docs/book"
35+
36+
- name: Deploy to GitHub Pages
37+
id: deployment
38+
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# hl [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![Release][release-img]][release]
1+
# hl [![Book][book-img]][book] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![Release][release-img]][release]
22

33
[![banner](docs/assets/banner.svg)](#screenshot)
44

@@ -871,6 +871,8 @@ Advanced Options:
871871

872872
* See [#132](https://github.com/pamburus/hl/issues/132) for how to repeat measurements
873873

874+
[book-img]: https://github.com/pamburus/hl/actions/workflows/book.yml/badge.svg?branch=feature/book
875+
[book]: https://pamburus.github.io/hl/
874876
[ci-img]: https://github.com/pamburus/hl/actions/workflows/ci.yml/badge.svg
875877
[ci]: https://github.com/pamburus/hl/actions/workflows/ci.yml
876878
[cov-img]: https://codecov.io/gh/pamburus/hl/graph/badge.svg?token=464MN13408

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/book/

docs/book.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[book]
2+
authors = ["hl contributors"]
3+
language = "en"
4+
src = "src"
5+
title = "hl - Log Viewer Guide"
6+
description = "Complete guide to using hl, a high-performance JSON and logfmt log viewer"
7+
8+
[output.html]
9+
git-repository-url = "https://github.com/pamburus/hl"

docs/src/SUMMARY.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Summary
2+
3+
[Introduction](./intro.md)
4+
5+
# Getting Started
6+
7+
- [Installation](./installation.md)
8+
- [Quick Start](./quick-start.md)
9+
10+
# Features
11+
12+
- [Viewing Logs](./features/viewing-logs.md)
13+
- [Automatic Pager Integration](./features/pager.md)
14+
- [Live Streaming](./features/streaming.md)
15+
- [Multiple Files](./features/multiple-files.md)
16+
- [Compressed Files](./features/compressed.md)
17+
18+
- [Filtering](./features/filtering.md)
19+
- [By Log Level](./features/filtering-level.md)
20+
- [By Field Values](./features/filtering-fields.md)
21+
- [By Time Range](./features/filtering-time.md)
22+
- [Complex Queries](./features/filtering-queries.md)
23+
24+
- [Sorting and Following](./features/sorting.md)
25+
- [Follow Mode](./features/follow-mode.md)
26+
27+
- [Output Formatting](./features/formatting.md)
28+
- [Field Visibility](./features/field-visibility.md)
29+
- [Time Display](./features/time-display.md)
30+
- [Field Expansion](./features/field-expansion.md)
31+
- [Raw Output](./features/raw-output.md)
32+
33+
- [Input Options](./features/input.md)
34+
- [Input Formats](./features/input-formats.md)
35+
- [Time Handling Overview](./features/time-handling-overview.md)
36+
- [Timestamp Handling](./features/timestamps.md)
37+
- [Non-JSON Prefixes](./features/prefixes.md)
38+
39+
# Customization
40+
41+
- [Configuration Files](./customization/config-files.md)
42+
- [Environment Variables](./customization/environment.md)
43+
- [Themes](./customization/themes.md)
44+
- [Stock Themes](./customization/themes-stock.md)
45+
- [Selecting Themes](./customization/themes-selecting.md)
46+
- [Custom Themes](./customization/themes-custom.md)
47+
- [Theme Overlays](./customization/themes-overlays.md)
48+
49+
# Examples
50+
51+
- [Basic Usage](./examples/basic.md)
52+
- [Filtering Examples](./examples/filtering.md)
53+
- [Query Examples](./examples/queries.md)
54+
- [Time Filtering](./examples/time-filtering.md)
55+
- [Field Management](./examples/field-management.md)
56+
- [Live Monitoring](./examples/live-monitoring.md)
57+
- [Working with Multiple Logs](./examples/multiple-logs.md)
58+
59+
# Reference
60+
61+
- [Command-Line Options](./reference/options.md)
62+
- [Query Syntax](./reference/query-syntax.md)
63+
- [Time Format Specifications](./reference/time-format.md)
64+
- [Performance Tips](./reference/performance.md)
65+
66+
# Help
67+
68+
- [Troubleshooting](./help/troubleshooting.md)
69+
- [FAQ](./help/faq.md)

0 commit comments

Comments
 (0)