@nrk/core-docs
Advanced tools
@nrk/core-docsmakes it easy to write documentation for your project in markdown and render it beautifully.
https://static.nrk.no/core-docs/latest/
core-docs can parse and render all markdown files you put in your repository. The only requirement is an index.html file which declares the menu as a <ul> and loads the core-docs script. Link to your markdown files using their relative path, prepended with ?. Example:
<!doctype html>
<head>
<meta charset="utf-8">
</head>
<ul>
<li><a href="?readme.md">Core Docs</a></li>
<li><a href="?example/readme.md">Nested</a></li>
<li><a href="?example/thing.md">More Docs</a></li>
<li><br><a href="https://github.com/nrkno/core-docs">View on Github</a></li>
<li><a href="https://github.com/nrkno/core-docs/releases">View changelog</a></li>
<li><a href="#" download>Download example</a></li>
</ul>
<script src="https://static.nrk.no/core-docs/major/4/core-docs.min.js" charset="utf-8"></script>
First clone @nrk/core-docs and install its dependencies:
git clone git@github.com:nrkno/core-docs.git
cd core-docs
npm install
npm start # Your browser will open documentation with hot reloading
After having applied changes, remember to build before pushing the changes upstream.
git checkout -b feature/my-changes
# update the source code
npm run build
git commit -am "Add my changes"
git push origin feature/my-changes
# then make a PR to the master branch,
# and assign another developer to review your code
NOTE! Please also make sure to keep commits small and clean (that the commit message actually refers to the updated files).
Stylistically, make sure the commit message is Capitalized and starts with a verb in the present tense (for exampleAdd minification support).
FAQs
Core documentation
The npm package @nrk/core-docs receives a total of 54 weekly downloads. As such, @nrk/core-docs popularity was classified as not popular.
We found that @nrk/core-docs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 165 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
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.