View Code? Open in Web Editor
NEW
This project forked from redhatinsights/better-platform-docs
License: Apache License 2.0
Shell 1.96%
JavaScript 17.71%
TypeScript 62.25%
Dockerfile 0.17%
MDX 17.91%
better-platform-docs's Introduction
- make sure you have an LTS node installed (16.x.x)
- to test "external mode", make sure you have docker-compose installed and can pull images from https://quay.io
- install dependencies with
npm install
- run
node downloader/downloader.mjs
to download the doc files
- run
npm run dev:compose
to kickstarts development server
- open your browser at http://locahost:3000
- add/change
.mdx?
files in the pages
directory
- In the desired repository add a
docker-compose.yml
. You can copy the docker-compose.yml
from this repository.
- In the copied
docker-compose.yml
, change the <repo-name>
for your project name. The name will be used as a root section route.
- In your project create
docs
directory.
- In the
docs
directory create Markdown files with documentation content.
- Run
docker-compose up
to spin the development environment.
- Open your browser at
http://locahost:3000/<repo-name>
.
- Continue editing content inside the
docs
directory.
better-platform-docs's People