Docs CMS

Common CMS for documentation using Lark Docs.

Docs CMS

About The Project

This is a Next.js project used to fetch documents using the Lark Server APIs and to display them online as documentation.

Getting Started

Set up

Before installing, you need to install Node.js. Run the following command to install it in the current project:

npm install

Set environment variables

Run the following command to copy the default example and replace with your own variables:

cp .env.example .env

Run the development server

npm run dev

Open http://localhost:3000 with your browser to see the result.

Search

Search is using Typesense.

Updating the search index

The scraper configuration is at scraper/typesense.json.

Minimum you need to edit the following:

{
  "index_name": "docs-cms-three-vercel-app",
  "start_urls": [
    "https://docs-cms-three.vercel.app/wiki/quick-start"
  ],
  "sitemap_urls": [
    "https://docs-cms-three.vercel.app/sitemap.xml"
  ],
  // ...
}

To scrape the site and update the index:

First, copy the default example and edit it:

cd scraper
cp .env.typesense.example .env.typesense

Thereafter, run docker compose up.

This can be automated, or run on demand.

Learn More

To learn more about Next.js, take a look at the following resources:

Next.js Documentation - learn about Next.js features and API.
Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out the Next.js deployment documentation for more details.

Contributing

If you encounter a bug or have a feature request, please use the Issue Tracker. The project is also open to contributions, so feel free to fork the project and open pull requests.

License

Distributed under the MIT License. See License for more information.

AElfProject/docs-cms