https://github.com/se-academic-group/thich-doc-truyen-docs

Documentation on development of Thich Doc Truyen website
https://github.com/se-academic-group/thich-doc-truyen-docs

docs nextjs nextra

Last synced: 25 days ago
JSON representation

Documentation on development of Thich Doc Truyen website

• Host: GitHub
• URL: https://github.com/se-academic-group/thich-doc-truyen-docs
• Owner: SE-Academic-Group
• License: mit
• Created: 2024-06-08T14:29:09.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-11T14:33:05.000Z (8 months ago)
• Last Synced: 2024-11-10T14:12:24.641Z (3 months ago)
• Topics: docs, nextjs, nextra
• Language: MDX
• Homepage: https://thich-doc-truyen-docs.vercel.app
• Size: 2.92 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Thích Đọc Truyện Docs Site

Documentation for Thich Doc Truyen web application (Frontend & Backend)

## Quick Start

You must have a grasp of Markdown to write docs (MDX is preferred)

Head to [Nextra Docs](https://nextra.site/docs) to see how you can write documentation the right way

## Writing Docs 101

1. A documentation page on a topic is written in a file

2. Group related files in a folder

3. You can modify the name of the displayed page or folder inside `pages/_meta.json`

4. Forget the `components` folder. It is for React component documentation.

## Prerequisites

1. [Node](https://nodejs.org/en) >= v18.21 (For the pnpm to work)

2. [pnpm](https://pnpm.io/) >= 9.1.0

## Local Development

You know how to clone this repo, right? And after cloning.

First, run `pnpm i` to install the dependencies.

Then, run `pnpm dev` to start the development server and visit [localhost:3000](localhost:3000).

## License

This project is licensed under the [MIT](https://opensource.org/license/mit) License.