You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@annotator.apache.org by ge...@apache.org on 2021/06/06 14:23:46 UTC
[incubator-annotator-website] 03/05: Warn that docs are for v0.2,
show npm dev tag
This is an automated email from the ASF dual-hosted git repository.
gerben pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-annotator-website.git
commit 0e52fd5188bcc354b3417382864c8f57c7447fab
Author: Gerben <ge...@treora.com>
AuthorDate: Sun Jun 6 16:12:43 2021 +0200
Warn that docs are for v0.2, show npm dev tag
---
src/_includes/docs_nav.hbs | 2 ++
src/docs/getting-started.md | 10 ++++++++--
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/src/_includes/docs_nav.hbs b/src/_includes/docs_nav.hbs
index 134da78..b7aa50c 100644
--- a/src/_includes/docs_nav.hbs
+++ b/src/_includes/docs_nav.hbs
@@ -3,6 +3,8 @@
Therefore: only use plain Handlebars code, no custom helpers etc.
--}}
<nav class="ui secondary stackable pointing menu" style="justify-content: center;">
+ <span class="item" style="background: #ff08">This documentation is for v0.2 (in development)</span>
+ <span class="item"></span>
<a href="/docs/" class="{{#if isDocsIndex}}active {{/if}}item">Overview</a>
<a href="/docs/getting-started/" class="{{#if isGettingStarted}}active {{/if}}item">Getting Started</a>
<a href="/docs/develop/" class="{{#if isDevelop}}active {{/if}}item">Develop</a>
diff --git a/src/docs/getting-started.md b/src/docs/getting-started.md
index 6f3d52f..891b16d 100644
--- a/src/docs/getting-started.md
+++ b/src/docs/getting-started.md
@@ -10,13 +10,19 @@ Currently we only support installation through NPM packages. You will need to us
The project is made up of multiple modules. Each module is [available on the NPM registry](https://www.npmjs.com/org/apache-annotator) as individual packages in the `@apache-annotator` scope, and all of them together in the [`apache-annotator`](https://www.npmjs.com/package/apache-annotator) ‘meta-package’. You can install either and then import packages in your code as `@apache-annotator/package` or `apache-annotator/package`, respectively.
-For example:
+For example, for the latest official release:
``` shell
$ yarn add @apache-annotator/dom
```
-…with in your code:
+For the latest development version, get the `dev` tag. For example:
+
+``` shell
+$ yarn add @apache-annotator/dom@dev
+```
+
+And in your code import what you need:
``` js
import { highlightRange } from '@apache-annotator/dom';