Edit and Run Your Docs Using Codespaces

Step 1: Go To Your External Docs

Sign into Dev-Docs and go to your external docs dashboard.

click on the text: Edit Your Docs

Step 2: Create Codespace

Create a codespace by clicking new codespace button.

Step 4: Run the Docs

Let the npm install command finish and copy and paste the command from the readme npm run start -- --host 0.0.0.0

Also a new tab should open that shows your running Dev-Docs repo like below.

Step 5: Add a new Doc

Now we are going to edit some of the docs. Go to your docs folder in the project, and find the docs directory.

Create a new .md file in the folder for example like My new Document Page.md

Step 7: Add Content

Now add some content to that markdown file.

Step 8: Preview Content

Now lets see the preview of our new document, go back to the preview tap or reopen by clicking on the Ports tab in the terminak.

Step 9: Navigate to Your new Doc

Then in the top left click Get Started. You should now see a new document page matching your content

Congrats you add a new document with codespaces