nrkno / core-docs Goto Github PK

We experience the background color of demos are confusing and seems to be part of component.

```js demo
// rendered demo component
```

the spec. Both github and marked supports this syntax

https://nrkno.github.io/kaleido-api/
https://github.com/nrkno/kaleido-api

wee - people want to borrow our toys :)

1. Remove NRK-logo from build
2. Make repo public

because... it's convenient to test code + write docs at in the same document.

some issues in ie9:

• document mode detected: QUIRKS MODE (because no doctype?)
• innerHTML read-only on some elements (facebook/react#515 (comment))
• polyfills

• husk å laste polyfill for custom element i starten

https://bidra-upload.mesosint.nrk.no/docs
https://github.com/nrkno/ds-bidra-upload/

Åpne denne og forminsk vindu.
https://ludo-test.dev.nrk.no/docs/docs/index.html?examples.md

Har gjort noen foreløpige justeringer direkte i source her her.
https://ludo-test.dev.nrk.no/master/docs/index.html?examples.md

Ludo's documentation could be enhanced and use core-docs. We should make a PR for their repo with suggested docs. Today they have some md files and this auto-generated page https://static.nrk.no/ludo/latest/index.html

Link to one or two real core-docs in the wild in main readme.
TODO when core-css etc uses new core-docs

core-docs doesn't work anymore in ie11, there's a cryptic error in the js console, possibly from one of the libs used.

When navigating away from the homepage in the docs, Origo is replaced with the title of the new page. I suggest keeping both, to make it easier to identify tabs in the browser-window.

Example:
Elements – Origo instead of Elements.

to reproduce:

• go to https://static.nrk.no/core-css/latest/index.html#switches
• scroll up/down
• layout is messed up

if possible, we should produce better error messages on transpiling markdown demo js.
now this js error in markdown

<script>origoAuthority('#demo-authority', { type: 'channel', foo: ... })</script>

produces this error console:

SyntaxError: Unexpected token (1:58) buble.es.js:2751:12
    raise buble.es.js:2751
    unexpected buble.es.js:670
    parseExprAtom buble.es.js:2211
    value buble.es.js:6086
    parseExprAtom buble.es.js:5959
    parseExprSubscripts buble.es.js:2062
    parseMaybeUnary buble.es.js:2039
    parseExprOps buble.es.js:1981
    parseMaybeConditional buble.es.js:1964
    parseMaybeAssign buble.es.js:1939
    parsePropertyValue buble.es.js:2458
    parseProperty buble.es.js:2449
    parseObj buble.es.js:2384
    parseExprAtom buble.es.js:2194
    value buble.es.js:6086
    parseExprAtom buble.es.js:5959
    parseExprSubscripts buble.es.js:2062
    parseMaybeUnary buble.es.js:2039
    parseExprOps buble.es.js:1981
    parseMaybeConditional buble.es.js:1964
    parseMaybeAssign buble.es.js:1939
    parseExprList buble.es.js:2657
    parseSubscripts buble.es.js:2090
    parseExprSubscripts buble.es.js:2065
    parseMaybeUnary buble.es.js:2039
    parseExprOps buble.es.js:1981
    parseMaybeConditional buble.es.js:1964
    parseMaybeAssign buble.es.js:1939
    parseExpression buble.es.js:1904
    parseStatement buble.es.js:838
    value buble.es.js:6074
    parseTopLevel buble.es.js:724
    parse buble.es.js:545
    parse buble.es.js:562
    vo buble.es.js:10226
    <anonymous> index.js:82
    r index.js:104

As subject suggests, should we implement a feature to add a brand logo (like NRK) as well as a sub-brand (e.g. the explicit product you're documenting)?

• Write to index.html and have core-docs include in page layout if present and possible option specified
• Allow for theme-specific markup

Maybe auto-generate tabs from <h4> levels?

so we can have readme's located logical places (for devs) and still have subtitles generated in one file for better readability (for ppl)

or better yet, remove it from the code.

Having multiple headings with the same text, i.e:

#Component 1
## Installation
#Component 2
## Installation

results in the same hash for #installation. These should either be prefixed with component-2 (if preceding heading exists) or unique id if no "parent heading" is found

Som en utvidelse av #21, ønsker jeg muligheten til å velge om h4 vises som tabs eller ikke. Gjerne i form av en konfigurasjonsfil som f.eks. core-docs.config.js.

because it's nice