@techdocs/cli
Advanced tools
Check out the TechDocs README to learn more.
WIP: This cli is a work in progress. It is not ready for use yet. Follow our progress on the Backstage Discord under #docs-like-code or on our GitHub Milestone.
# Serve localhost:3000 (and localhost:8000)
yarn serve
# Serve localhost:8000 containing your Mkdocs documentation.
yarn serve:mkdocs
You'll need Docker installed and running to use this. You will also need to build the container located at /packages/techdocs-container under the tag mkdocs:local-dev, as you can see in the commands from below:
docker build packages/techdocs-container -t mkdocs:local-dev
From that point, you can invoke the CLI from any project with a docs folder. Try out our example!
cd packages/techdocs-container/mock-docs
npx @techdocs/cli serve
You'll need Docker installed and running to use this. You will also need to build the container located at packages/techdocs-container under the tag mkdocs:local-dev (for now until we deploy the container to a centralized Docker registry), as you can see in the commands from below:
docker build packages/techdocs-container -t mkdocs:local-dev
cd packages/techdocs-container/mock-docs
npx techdocs serve
You should have a localhost:3000 serving TechDocs in Backstage, as well as localhost:8000 serving Mkdocs (which won't open up and be exposed to the user).
Happy hacking!
FAQs
Utility CLI for managing TechDocs sites in Backstage.
The npm package @techdocs/cli receives a total of 20,410 weekly downloads. As such, @techdocs/cli popularity was classified as popular.
We found that @techdocs/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.