Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mika-f/nekodoc
NekoDoc is static documentation site generator written in React and TypeScript, powered by Markdown.
https://github.com/mika-f/nekodoc
Last synced: 4 days ago
JSON representation
NekoDoc is static documentation site generator written in React and TypeScript, powered by Markdown.
- Host: GitHub
- URL: https://github.com/mika-f/nekodoc
- Owner: mika-f
- License: mit
- Created: 2022-08-15T04:58:25.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-30T10:47:00.000Z (about 2 years ago)
- Last Synced: 2024-10-28T09:47:16.468Z (17 days ago)
- Language: TypeScript
- Homepage: https://www.nekodoc.com
- Size: 597 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project: NekoDoc
## Overview
NekoDoc is a static site generator that focused on project documentation, api documentation, and product documentation.
Documentation sources are written in Markdown and MDX, and zero-configuration start-up.
## Requirements
- Node.js >= 16
## Usage
```bash
# install and init project
$ yarn add nekodoc
$ yarn run nekodoc init
# serve preview project
$ yarn run nekodoc start
# build as static website
$ yarn run nekodoc build
```
## Features
### Markdown as Content
No need to write HTML, CSS, and JavaScript writing your content.
You can focus to writing the contents.
### Work on All Devices
Once deployed, it works on most devices regardless of the type of devices such as mobile, tablet, and PC.
### Highly Customizable
Are you want to use Tab, Code Highlight with Line Numbers, Buttons, and other UI components? You can use them with MDX.
If you are familiar with React, you can even use React components you've written yourself as part of MDX.
If not, you can also install and use various components using the theme provided.
No need to worry about dialects anymore.
### Zero Configuration
No configuration needed to serve project.
Also, if you want to change the configurations, you can change it without being bothered by using the configurations with code completion.
### Open Source
You can use this software in commercial and non-commercial use for feel free.
## License
MIT by [@6jz](https://twitter.com/6jz)