Add a readme with generated API docs

marijnh · marijnh · commit c1fb0553baf4 · 2020-12-30T18:06:03.000+01:00
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+<!-- NOTE: README.md is generated from src/README.md -->
+
 # @codemirror/lang-cpp [![NPM version](https://img.shields.io/npm/v/@codemirror/lang-cpp.svg)](https://www.npmjs.org/package/@codemirror/lang-cpp)
 
 [ [**WEBSITE**](https://codemirror.net/6/) | [**ISSUES**](https://github.com/codemirror/codemirror.next/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/lang-cpp/blob/main/CHANGELOG.md) ]
@@ -16,3 +18,20 @@ We aim to be an inclusive, welcoming community. To make that explicit,
 we have a [code of
 conduct](http://contributor-covenant.org/version/1/1/0/) that applies
 to communication around the project.
+
+## API Reference
+<dl>
+<dt id="user-content-cpp">
+  <code><strong><a href="#user-content-cpp">cpp</a></strong>() → <a href="https://codemirror.net/6/docs/ref#language.LanguageSupport">LanguageSupport</a></code></dt>
+
+<dd><p>Language support for C++.</p>
+</dd>
+<dt id="user-content-cpplanguage">
+  <code><strong><a href="#user-content-cpplanguage">cppLanguage</a></strong>: <a href="https://codemirror.net/6/docs/ref#language.LezerLanguage">LezerLanguage</a></code></dt>
+
+<dd><p>A language provider based on the <a href="https://github.com/lezer-parser/cpp">Lezer C++
+parser</a>, extended with
+highlighting and indentation information.</p>
+</dd>
+</dl>
+
diff --git a/src/README.md b/src/README.md
@@ -0,0 +1,26 @@
+<!-- NOTE: README.md is generated from src/README.md -->
+
+# @codemirror/lang-cpp [![NPM version](https://img.shields.io/npm/v/@codemirror/lang-cpp.svg)](https://www.npmjs.org/package/@codemirror/lang-cpp)
+
+[ [**WEBSITE**](https://codemirror.net/6/) | [**ISSUES**](https://github.com/codemirror/codemirror.next/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/lang-cpp/blob/main/CHANGELOG.md) ]
+
+This package implements C++ language support for the
+[CodeMirror](https://codemirror.net/6/) code editor.
+
+The [project page](https://codemirror.net/6/) has more information, a
+number of [examples](https://codemirror.net/6/examples/) and the
+[documentation](https://codemirror.net/6/docs/).
+
+This code is released under an
+[MIT license](https://github.com/codemirror/lang-cpp/tree/main/LICENSE).
+
+We aim to be an inclusive, welcoming community. To make that explicit,
+we have a [code of
+conduct](http://contributor-covenant.org/version/1/1/0/) that applies
+to communication around the project.
+
+## API Reference
+
+@cpp
+
+@cppLanguage
