Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xizon/nextjs-doc-template
A documentation template based on NextJS and Nextra that exports pure HTML files.
https://github.com/xizon/nextjs-doc-template
docs documentation next nextjs nextra
Last synced: 4 months ago
JSON representation
A documentation template based on NextJS and Nextra that exports pure HTML files.
- Host: GitHub
- URL: https://github.com/xizon/nextjs-doc-template
- Owner: xizon
- License: mit
- Created: 2024-07-18T03:42:28.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-12T03:15:44.000Z (6 months ago)
- Last Synced: 2024-09-27T18:03:27.142Z (4 months ago)
- Topics: docs, documentation, next, nextjs, nextra
- Language: TypeScript
- Homepage: https://nextjs-doc-template.vercel.app/
- Size: 946 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nextjs Doc Template
A documentation template based on NextJS and Nextra that exports pure HTML files.
## Getting Started
Make sure if NODEJS is installed on your computer.
### Install Dependencies:
```sh
$ npm install
```
### Run Project in development mode:
```sh
$ npm run dev
```
With is command file will be compiled and it will be loaded on local server [http://localhost:3000](http://localhost:3000).
### Production Build :
```sh
$ npm run build
```
### Start a Next.js production server:
```sh
$ npm run start
```
### Export your Next.js application to static HTML
> Pure HTML Static Files (**.html**)
**Step 1. generate static resources:**
```sh
$ npm run export
```
**Step 2. fix name for HTML files:**
```sh
$ npm run export:fix
```
## Contributing
- [React](https://reactjs.org/)
- [nextjs](https://nextjs.org/)
- [Nextra](https://nextra.site/)
- [Funda UI](https://github.com/xizon/funda-ui) - for External Component Test
## Supported development environment
- Nextra 2+
- Next.js 14+
- React 18 +
- TypeScript 4.x.x +
## Licensing
Licensed under the [MIT](https://opensource.org/licenses/MIT).