paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 48 Packages Projects Releases Wiki Activity

techdocs: implement serve for the techdocs-cli (#1581)

Browse Source 
* feat(techdocs-cli): point techdocs export to localhost:3000/api

* feat(techdocs-cli): add http-proxy package

* feat(techdocs-cli): add react-dev-utils package

* feat(techdocs-cli): implement serve and serve:mkdocs commands

* fix: use [module] prefix convention in console.log

* docs: added commands

* wip

* Fix type errors

Co-authored-by: Sebastian Qvarfordt <s.qvarfordt@gmail.com>
This commit is contained in:
Bilawal Hameed
2020-07-10 16:01:45 +02:00
committed by GitHub
parent 6d19a3a5ba
commit 353cf5a14f
6 changed files with 156 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/techdocs-cli/README.md
+10
View File
@@ -4,6 +4,16 @@ Check out the [TechDocs README](https://github.com/spotify/backstage/blob/master
**WIP: This cli is a work in progress. It is not ready for use yet. Follow our progress on [the Backstage Discord](https://discord.gg/MUpMjP2) under #docs-like-code or on [our GitHub Milestone](https://github.com/spotify/backstage/milestone/15).**
## Commands
```bash
# Serve localhost:3000 (and localhost:8000)
yarn serve
# Serve localhost:8000 containing your Mkdocs documentation.
yarn serve:mkdocs
```
## Getting Started
You'll need Docker installed and running to use this. You will also need to build the container located at `plugins/techdocs/mkdocs/container` under the tag `mkdocs:local-dev`, as you can see in the commands from below: