docs-builder
Advanced tools
Use your Markdowns to create some HTMLs. This is still work in progress so this is very very bad.
Use your Markdowns to create some HTMLs. This is still work in progress so this is very very bad.
Version: 0.3.0
See CHANGELOG.md to see changes.
You can install this package globally using npm install docs-builder -g and use the doc [args...] command.
Or run the npx command npx docs-builder [args...].
Then, create this file structure:
my-documentation/
├── <in>/
├──── .sidebar.yaml
├──── .template.html
├──── readme.md
├──── *.md
├──── (Other files)
└── (Other files)
In the .sidebar.yaml, write some YAML:
- index
- my-page
- my-page2
index is the main page (readme.md)
In the .template.html, write some HTML:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>{title}</title>
</head>
<body>
<docs-sidebar></docs-sidebar>
<docs-content></docs-content>
</body>
</html>
<docs-title></docs-title> and {title} will be replaced by the title (The first h1 element of the content).
<docs-content></docs-content> will be replaced by the content.
<docs-sidebar></docs-sidebar> will be replaced by the data of .sidebar.yaml (without style).
Create some markdown file to document your creation!
Input:
[my page](./my-page.md)
Output:
<p><a href="my-page">my page</a></p>
<p><img src="my-img.png" alt="image" /></p>
Links that link to a markdown file will be replaced by the relative path of the page.
Images will be replaced by the relative path of the image.
Run doc build <in> <out>!
FAQs
Use your Markdowns to create some HTMLs. This is still work in progress so this is very very bad.
We found that docs-builder demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer 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
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.