https://github.com/FuelLabs/typedoc-just-the-docs-theme
https://github.com/FuelLabs/typedoc-just-the-docs-theme
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/FuelLabs/typedoc-just-the-docs-theme
- Owner: FuelLabs
- License: apache-2.0
- Created: 2022-02-07T15:42:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-08T22:00:23.000Z (over 3 years ago)
- Last Synced: 2024-04-24T09:25:34.162Z (about 2 years ago)
- Language: TypeScript
- Size: 6.84 KB
- Stars: 4
- Watchers: 18
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typedoc-just-the-docs-theme
This theme is made to work with the [jekyll](https://jekyllrb.com/) theme [just-the-docs](https://github.com/pmarsceill/just-the-docs). It also requires
[typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown) to work.
> Supports TypeDoc 0.22.x
### What is does?
```
Note this theme was not extensively tested and was made to cover a single use case.
```
- Generates github well organized path directory
- Append on each markdown page a `YML front matter` with specifies from `just-the-docs`.
### Requirements
- [typedoc](https://github.com/TypeStrong/typedoc)
- [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown)
### Usage
```shell
npm install typedoc-just-the-docs-theme --save-dev
```
On `typedoc.json` file.
```json
{
"theme": "just-the-docs"
}
```
### Road map
- [ ] Add tests