@concordance-wiki/ui
v1.0.0
Published
Client components: mentions panel, mini-map, viewer slots, trail.
Downloads
249
Readme
Why
Concordance publishes a static wiki whose interactive parts, the mentions panel, the table of contents, the pinned pages, the side panels, the viewers, are components of the default theme. You install @concordance-wiki/concordance for that. This package holds the name under which those components will be published on their own, for a second theme that wants them without the default one. In 0.1.x it exports nothing; the components live in @concordance-wiki/site. There is no reason to install it before a version says otherwise in its changelog.
Quick start
npm install @concordance-wiki/uiimport * as ui from "@concordance-wiki/ui";
Object.keys(ui); // []What you get
- An empty entry point,
dist/index.js, so that the package name is reserved and its version moves with the others. - Nothing else yet. The islands of the site are described in the theming guide, where they live today.
Documentation
- Theming, where the islands and the components of the site are described today
- Home page, the demo wiki and the changelog
Part of Concordance, MIT licence.
The islands of the site (mentions panel, table of contents, tabs, pinned pages, side panels, mode switch, contract viewer, document viewer) are implemented in the site package, next to the default theme that composes them, and bundled by it. This package will take the ones that make sense on their own once a second theme needs them without the default one.
