https://github.com/nrkno/core-docs

Write documentation in markdown and render it beautifully
https://github.com/nrkno/core-docs

documentation markdown

Last synced: 8 months ago
JSON representation

Write documentation in markdown and render it beautifully

• Host: GitHub
• URL: https://github.com/nrkno/core-docs
• Owner: nrkno
• License: mit
• Created: 2018-12-04T12:29:12.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-05-09T11:40:41.000Z (about 1 year ago)
• Last Synced: 2025-06-16T12:56:10.603Z (about 1 year ago)
• Topics: documentation, markdown
• Language: JavaScript
• Homepage: https://static.nrk.no/core-docs/latest/
• Size: 1.1 MB
• Stars: 4
• Watchers: 65
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @nrk/core-docs

> `@nrk/core-docs` makes it easy to write documentation for your project in [markdown](https://github.com/markedjs/marked) and 

render it beautifully.

## Documentation

https://static.nrk.no/core-docs/latest/

## Getting started

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 `
` and loads the core-docs script. Link to your markdown files using their relative path, prepended with `?`. Example:


```html

  



  
Core Docs

  
Nested

  
More Docs

  



View on Github



  
View changelog

  
Download example



```

## Local development

First clone `@nrk/core-docs` and install its dependencies:

```bash

git clone git@github.com:nrkno/core-docs.git

cd core-docs

npm install

npm start # Your browser will open documentation with hot reloading

```

## Building and committing

After having applied changes, remember to build before pushing the changes upstream.

```bash

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 example `Add minification support`).