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)

mdx
Searching Database…

36.5K ·GitHub
Docs
What is this?This is the documentation website for InkChain (Ink), a documentation platform built with Next.js and Nextra that hosts InkChain's docs.
Is this a standalone app or just markdown files?It's a full Next.js web application powered by Nextra (using the Pages Router), not just a folder of markdown files.
How do I run this locally?Clone the repo, install dependencies, then run the dev server (next dev); it can also be built and run as a Docker image.
What do I need installed first?You need Node.js v20.11.0 or higher; dependencies are managed via the package.json (Next.js, Nextra, React).
Is it using the latest Next.js App Router?No, it's still on the Pages Router because of compatibility limitations with Nextra and hasn't been upgraded to the App Router.
Where does this run?It runs as a web app, deployed to production via AWS Amplify on the main branch, with temporary preview environments for every PR.
What tools keep the docs quality-checked?The repo uses CSpell for spell checking, Remark for markdown processing, ESLint for code quality, Prettier for formatting, and Tailwind CSS for styling.
What happens when I open a PR?GitHub Actions runs lint, markdown-lint, format, and spell-check jobs, and AWS Amplify deploys a temporary preview environment with a URL posted in the PR checks.
How do I add a custom term so spell-check doesn't flag it?Add unique terms like 'InkChain' to the ./cspell/project-words.txt file to whitelist them.
What are similar projects?fumadocs, nextra, cheatsheets, docusaurus, docz, NotionNext, dshfind, reposcope
Which topics is it in?eslint, mdx, static-site-generator, tailwindcss, github-actions, ci, nextjs, documentation, markdown, web-app, react, frontend
Creator
inkonchain
Size
25.3 MB
Stars
36.5K
Updated
CommitOct 14
Age
2y
Commits · 90 Days