lildocs 0.0.0 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +67 -0
- package/dist/cli.mjs +2315 -0
- package/dist/core/github-pages.mjs +2 -0
- package/dist/github-pages-0s3VHkYL.mjs +74 -0
- package/dist/render/copy-code.js +51 -0
- package/dist/render/github-icon.svg +6 -0
- package/dist/render/navigation.js +14 -0
- package/dist/render/search.js +3239 -0
- package/dist/render/styles.css +650 -0
- package/package.json +51 -10
- package/readme.md +0 -1
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# lildocs
|
|
2
|
+
|
|
3
|
+
`lildocs` is a small Node/TypeScript CLI that turns Markdown files into a static,
|
|
4
|
+
searchable documentation site.
|
|
5
|
+
|
|
6
|
+
It is built for projects that already keep docs in a repository and want a
|
|
7
|
+
complete site without MDX, hosted search, or a large theme system. Point it at a
|
|
8
|
+
folder or a single Markdown file and it finds the home page, infers navigation
|
|
9
|
+
from the folder structure and home page links, renders Markdown and Mermaid,
|
|
10
|
+
copies local assets, and writes self-contained HTML.
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
lildocs ./docs
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Generated sites use relative links and a local search index, so they work from
|
|
17
|
+
disk or from any static file host.
|
|
18
|
+
|
|
19
|
+
## What it covers
|
|
20
|
+
|
|
21
|
+
- Markdown folders or individual Markdown entry files
|
|
22
|
+
- Generated navigation, page titles, heading anchors, and table-of-contents data
|
|
23
|
+
- GitHub-flavored Markdown, frontmatter, callouts, code highlighting, images,
|
|
24
|
+
assets, and Mermaid diagrams
|
|
25
|
+
- Local static search with no external service
|
|
26
|
+
- Build, development server, and GitHub Pages output modes
|
|
27
|
+
- Lightweight theming with system light/dark defaults, built-in themes, Shiki
|
|
28
|
+
themes, local `theme.ts`, favicon/logo options, and font/background/link
|
|
29
|
+
options
|
|
30
|
+
|
|
31
|
+
## Documentation
|
|
32
|
+
|
|
33
|
+
- [Getting started](https://aleclarson.github.io/lildocs/getting-started.html)
|
|
34
|
+
- [Authoring docs](https://aleclarson.github.io/lildocs/guides/authoring.html)
|
|
35
|
+
- [GitHub Pages deployment](https://aleclarson.github.io/lildocs/guides/github-pages.html)
|
|
36
|
+
- [CLI reference](https://aleclarson.github.io/lildocs/reference/cli.html)
|
|
37
|
+
- [Configuration reference](https://aleclarson.github.io/lildocs/reference/configuration.html)
|
|
38
|
+
- [Themes and styling](https://aleclarson.github.io/lildocs/reference/theming.html)
|
|
39
|
+
|
|
40
|
+
`lildocs` is intentionally narrow: no manual nav config, versioned docs, MDX,
|
|
41
|
+
plugin system, hosted search, auth, CMS features, i18n, redirects, analytics, or
|
|
42
|
+
API reference generation.
|
|
43
|
+
|
|
44
|
+
## Contributing
|
|
45
|
+
|
|
46
|
+
Use these commands when working on lildocs itself:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
pnpm install
|
|
50
|
+
pnpm run format
|
|
51
|
+
pnpm run lint
|
|
52
|
+
pnpm run typecheck
|
|
53
|
+
pnpm test
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Keep behavior aligned with the README, documentation, and existing tests.
|
|
57
|
+
|
|
58
|
+
The project uses:
|
|
59
|
+
|
|
60
|
+
- `cmd-ts` for CLI parsing
|
|
61
|
+
- Preact SSR for rendering
|
|
62
|
+
- `marked` and `gray-matter` for Markdown and frontmatter
|
|
63
|
+
- `jiti` for theme loading
|
|
64
|
+
- `tsdown` for bundling
|
|
65
|
+
- `oxlint` for linting
|
|
66
|
+
- `oxfmt` for formatting
|
|
67
|
+
- Node's built-in `node:test` runner
|