@nrk/core-docs

    2.1.0-0 • Public • Published

    @nrk/core-docs

    @nrk/core-docs makes it easy to write documentation for your project in markdown 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 <ul> and loads the core-docs script. Link to your markdown files using their relative path, prepended with ?. Example:

    <!doctype html>
    <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/2/core-docs.min.js" charset="utf-8"></script>

    Local development

    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

    Building and committing

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

    Keywords

    none

    Install

    npm i @nrk/core-docs

    DownloadsWeekly Downloads

    80

    Version

    2.1.0-0

    License

    MIT

    Unpacked Size

    25 kB

    Total Files

    9

    Last publish

    Collaborators

    • danjohnrk
    • olapeter
    • teodor-elstad
    • michaelpande
    • lysebraate
    • yngvar-nrk
    • lorecaster
    • wwalmnes
    • nrk-ps-teamcity
    • vincent.andersson
    • swla
    • nrk-midas-jenkins
    • andorpandor
    • jarlelin
    • aevare
    • nrkrichard
    • gesi
    • gundelsby-nrk
    • jonstalecarlsen
    • machineboy
    • vagifabilov
    • nrk-sofie-ci
    • nytamin
    • jesperstarkar
    • loftum
    • emte123
    • skjalgepalg
    • eirikhalvard
    • snorreeb
    • astokke
    • n640071
    • n07073
    • kristian.rosenvold
    • henrik-mattsson
    • eirikbacker
    • haavardm
    • popeindustries
    • yr
    • nrk-kurator-jenkins
    • toshb
    • torgeilo
    • nrk-user-sync
    • dhdeploy
    • janerikbr
    • espenwa
    • rogerhmar
    • ovstetun
    • eivind
    • stianlj
    • haraldkj
    • mariusu
    • spesialsnorre
    • geirt
    • cristobal
    • knuthaug
    • thohalv
    • johnarne
    • nrk-sup-jenkins
    • eshaswini
    • morrow
    • oyvindeh
    • laat
    • toggu
    • nrk-jenkins
    • plomma
    • evjand
    • moltubakk
    • erlord
    • ingridguren
    • lu-lux
    • andersli
    • silje
    • stiandg
    • sjurlur
    • anderscan
    • terjemeisingset
    • andipodnrk
    • pkej
    • yosrimti
    • zenangst
    • morten.nyhaug
    • ingvildcath
    • erlend.jones
    • brneirik
    • mollerse
    • eriksalhus
    • frdrks
    • tbnrk
    • nordanke
    • balte
    • mikaelrss
    • simonmitternacht
    • christiankarlsson9
    • martintorgersen
    • rebchr
    • steipal
    • discobus
    • ingvesund
    • martingundersen
    • tinkajts
    • hallvardlid
    • tomivar
    • ajaco
    • tobinus
    • mortenok
    • nrk-ark-deploy
    • jeangilbertlouis
    • heidimork
    • ingriddraagen
    • fridajalborg
    • bruusi
    • rosvoll
    • christianeide
    • andreeide
    • enordby
    • artzag
    • glen_imrie
    • mia.aasbakken
    • danielo200
    • elathamna
    • evjjan17
    • olatoft
    • kongsrud
    • chrpeter
    • ingvildforseth
    • esseb
    • talepre
    • haraldk76
    • stigok
    • dagfinno
    • johannesodland
    • anders993
    • vildefj
    • vildepk
    • malinaandahl
    • filonenkodmitry
    • andreakn
    • rolerboler
    • meloygutt
    • anders.baggethun