docs README

The project's README from github.com/inkonchain/docs. As one markdown file: README.md.

Twitter

InkChain Documentation App

An advanced, streamlined documentation platform built with Next.js and Nextra for InkChain.

🚀 Build & Run

  1. Build Docker image:

    docker build -t docs .
    
  2. Run Docker container:

    docker run -p 3000:3000 docs
    

📋 Requirements

📖 Overview

This is a documentation application powered by Nextra and built on Next.js. Nextra simplifies the creation of documentation sites, allowing us to leverage the Pages Router for efficient navigation and routing. Currently, due to compatibility limitations, we have not yet upgraded to the App Router.

🏁 Getting Started

To get started with local development:

  1. Clone the repository
  2. Install dependencies:
    pnpm install
    
  3. Start development server:
    pnpm run dev
    

🛠 Tooling

Our development setup includes multiple tools to maintain high-quality code and documentation:

🚦 CI/CD Pipeline

Our CI/CD setup utilizes GitHub Actions to run automated checks on every pull request (PR):

🌐 Feature Branch Deployment

For every new PR, our CI/CD pipeline deploys a temporary environment via AWS Amplify. This real-time deployment enables live testing and review of changes before merging, ensuring a smoother workflow. The deployment URL is automatically provided within the PR checks, allowing team members to interact with new features.

🚀 Production Deployment

The main branch is configured for automatic continuous deployment via AWS Amplify. Every merge triggers a new build and deployment, ensuring that the latest version of the documentation is available to users without manual intervention.

docs (inkonchain/docs)

Searching Database…

36.5K ·GitHub
这是什么?这是 InkChain(Ink)的文档网站,一个基于 Next.js 和 Nextra 构建的文档平台,用来托管 InkChain 的文档。
这是独立的应用,还是只是一堆 Markdown 文件?这是一个完整的 Next.js 网页应用,由 Nextra 驱动(使用 Pages Router),而不只是一组 Markdown 文件。
我怎么在本地运行它?克隆仓库,安装依赖,然后运行开发服务器(next dev);也可以构建为 Docker 镜像并运行。
我需要先安装什么?你需要先安装 Node.js v20.11.0 或更高版本;依赖通过 package.json 管理(Next.js、Nextra、React)。
它用的是最新的 Next.js App Router 吗?不是,它仍在使用 Pages Router,因为与 Nextra 存在兼容性限制,尚未升级到 App Router。
它在哪里运行?它以网页应用的形式运行,main 分支通过 AWS Amplify 部署到生产环境,同时每个 PR 都会有临时预览环境。
有哪些工具确保文档质量?仓库使用 CSpell 做拼写检查,使用 Remark 处理 Markdown,使用 ESLint 检查代码质量,使用 Prettier 统一格式,并使用 Tailwind CSS 处理样式。
我提交 PR 后会发生什么?GitHub Actions 会运行代码检查、Markdown 检查、格式检查和拼写检查任务;AWS Amplify 会部署一个临时预览环境,并在 PR 检查项中发布其链接。
我怎样添加自定义词汇,避免被拼写检查标记?把 'InkChain' 这类独有词汇添加到 ./cspell/project-words.txt 文件中,即可将其加入白名单。
Creator
inkonchain
Size
25.3 MB
Stars
36.5K
Updated
CommitOct 14
Age
2y
Commits · 90 Days