https://github.com/gillchristian/docs-ts-mkdocs

https://github.com/gillchristian/docs-ts-mkdocs

docs generator typescript

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/gillchristian/docs-ts-mkdocs
• Owner: gillchristian
• Created: 2021-01-28T10:29:14.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T20:29:34.000Z (about 2 years ago)
• Last Synced: 2024-09-07T19:44:02.033Z (4 months ago)
• Topics: docs, generator, typescript
• Language: TypeScript
• Homepage: http://gillchristian.github.io/docs-ts-mkdocs
• Size: 146 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# docs-ts-mkdocs

An [MkDocs](https://www.mkdocs.org/) generator from [docs-ts](https://github.com/gcanti/docs-ts) documentation.

## Rationale & How It Works

[docs-ts](https://github.com/gcanti/docs-ts) output is meant to be deployed with

[GitHub Pages](https://pages.github.com/) (using [Jekyll](https://jekyllrb.com/) under the hood).

`docs-ts-mkdocs` must be run after `docs-ts`: it adds a `nav:` section to `mkdocs.yml` based on the generated `docs/`

directory.

All the directories and markdown files in `docs/` are added to the main navigation. And the `docs/modules` is treversed

adding `index.md` files on every directory with a table of contents of the directory files.

## Install and use

```

npm i --dev docs-ts docs-ts-mkdocs

```

```

npm run docs-ts

npm run docs-ts-mkdocs

```

See [docs-ts](https://github.com/gcanti/docs-ts) on how to configure.

NOTES: for now the `outDir` is expected to be `docs/` (the default one).