Update example files and examples script

examples/basics/docs-examples-from-docusaurus/doc1.md

@@ -0,0 +1,164 @@
+---
+id: doc1
+title: Docusaurus
+sidebar_title: Docusaurus Guide
+layout: docs
+category: Docusaurus
+permalink: docs/en/doc1.html
+next: doc2
+---
+
+## Getting Started
+
+In your project repo, make sure you have a `docs` folder containing all of your documentation files written in markdown. Create a `website` folder inside which you will install and run docusaurus. If you wish, you can also include a `blog` folder in your project repo at the same level as the `docs` folder for blog posts.
+
+Install Docusaurus using `npm`:
+
+```
+cd website
+npm install --save-dev docusaurus
+```
+
+In your `package.json` file, add the following scripts for docusaurus:
+
+```json
+"scripts": {
+  "start": "docusaurus-start",
+  "build": "docusaurus-build",
+  "publish-gh-pages": "docusaurus-publish",
+  "examples": "docusaurus-examples"
+}
+```
+
+To create example files for configuration, run `examples` using npm:
+
+```
+npm run examples
+```
+
+This will create the following files in your website folder:
+
+```
+core/Footer.js
+example-docs/en/doc1.md
+example-docs/en/doc2.md
+example-docs/en/doc3.md
+example-docs/en/exampledoc4.md
+example-docs/en/exampledoc5.md
+example-blog/2016-03-11-blog-post.md
+example-blog/2017-04-10-blog-post-two.md
+i18n/en.js
+pages/en/help.js
+pages/en/index.js
+pages/en/users.js
+static/img/...
+languages.js
+siteConfig.js
+```
+
+`examples` will not overwrite any existing files of the same name in your website folder.
+
+## Configuration
+
+The provided example files contain configurations for an example project `deltice/test-site` and with the documents in `example-docs/` and blog posts in `example-blog/`. These are provided for your reference to help you configure your project.
+
+### Document and Blog Front Matters
+
+Documentation should contain front matter that follows this example:
+```
+---
+id: doc1 <!-- used for docs to find each other and to map links -->
+title: Document Title
+layout: docs1 <!-- used to determine different sidebar groupings -->
+category: Sidebar Category 1 <!-- Category on the sidebar under which this doc goes -->
+permalink: docs/en/doc1.html <!-- link to the document that is used for site -->
+previous: doc0 <!-- previous doc on sidebar for navigation -->
+next: doc2 <!-- next doc on the sidebar for navigation -->
+<!-- don't include next if this is the last doc; don't include previous if first doc -->
+---
+```
+
+Blog posts should be written as markdown files with the following front matter:
+```
+---
+title: Blog Post Title
+author: Author Name
+authorURL: http://twitter.com/author <!-- (or some other link) -->
+authorFBID: 21315325 <!-- id to get author's picture -->
+---
+```
+In the blog post you should include a line `<!--truncate-->`. This will determine under which point text will be ignored when generating the preview of your blog post. Blog posts should have the file name format: `yyyy-mm-dd-your-file-name.md`.
+
+### Language Configurations
+
+If you wish to support websites for other languages, the `languages.js` file provides a list of what languages you wish to enable. Files in the `i18n` folder will provide localized versions of various strings.
+
+If you only wish to have an English version of your site, the `i18n` folder and the `languages.js` file are not necessary to run Docusaurus and should be deleted. 
+
+### Site Configurations
+
+Configure the siteConfig.js file which has comments guiding you through what needs to be done and how each configuration affects your website.
+
+Customize core/Footer.js which will serve as the footer for each page on your website.
+
+Include your own top-level pages as React components in `pages/`. These components should just be the body sections of the pages you want, and they will be included with the header and footer that the rest of Docusaurus uses. Examples are provided for your reference. Currently, if you want to add other React components to your pages, you must include all of it inside that file due to how `require` paths are set-up. You may also include `.html` files directly, but this is not recommended, and these will just be served as is and will not have any of the header/footer/styles shared by the rest of Docusaurus.
+
+All images and other static assets you wish to include should be placed inside the `static` folder. Any `.css` files provided in `static` will be concatenated to the standard styles provided by Docusaurus and used site-wide.
+
+Files placed in `static/` will be accessible in the following way: `static/img/image.png` will be accessible at `img/image.png`.
+
+## Using Docusaurus
+
+### Run the Server
+
+To run your website locally run the script:
+
+```
+npm run start
+```
+
+This will start a server hosting your website locally at `localhost:3000`. This server will ignore any occurences `siteConfig.baseUrl` in URLs, e.g. `localhost:3000/your-site/index.html` will be the same as `localhost:3000/index.html`. Any changes to configured files will be reflected by refreshing the page, i.e. the server does not need to be restarted to show changes.
+
+
+### Build Static Pages
+
+To create a static build of your website, run the script:
+
+```
+npm run build
+```
+
+This will generate `.html` files from all of your docs and other pages included in `pages/`. This allows you to check whether or not all your files are being generated correctly. The build folder is inside Docusaurus's directory inside `node_modules`.
+
+### Publishing Your Website
+
+Use CircleCI to publish your website whenever your project repo is updated. Configure your circle.yml file in your project repo to run commands to publish to GitHub Pages. An example is shown here:
+
+```yaml
+machine:
+  node:
+    version: 6.10.3
+  npm:
+    version: 3.10.10
+
+test:
+  override:
+    - "true"
+
+deployment:
+  website:
+    branch: master
+    commands:
+      - git config --global user.email "test-site-bot@users.noreply.github.com"
+      - git config --global user.name "Website Deployment Script"
+      - echo "machine github.com login test-site-bot password $GITHUB_TOKEN" > ~/.netrc
+      - cd website && npm install && GIT_USER=test-site-bot npm run publish-gh-pages
+```
+
+Note that in this case a GitHub user `test-site-bot` is created to use just for publishing. Make sure to give your Git user push permissions for your project and to set a GITHUB_TOKEN environment variable in Circle if you choose to publish this way.
+
+If you wish to manually publish your website with the `publish-gh-pages` script, run the following example command with the appropriate variables for your project:
+
+```
+DEPLOY_USER=deltice GIT_USER=test-site-bot CIRCLE_PROJECT_USERNAME=deltice CIRCLE_PROJECT_REPONAME=test-site CIRCLE_BRANCH=master npm run publish-gh-pages
+```

examples/basics/docs-examples-from-docusaurus/doc2.md

@@ -0,0 +1,12 @@
+---
+id: doc2
+title: document number 2
+layout: docs
+category: First Category
+permalink: docs/en/doc2.html
+previous: doc1
+next: doc3
+---
+
+This is a link to [another document.](/docs/en/doc3.md)  
+This is a link to an [external page.](http://www.example.com)

examples/basics/docs-examples-from-docusaurus/doc3.md

@@ -0,0 +1,17 @@
+---
+id: doc3
+title: This is document number 3
+layout: docs
+category: Second Category
+permalink: docs/en/doc3.html
+previous: doc2
+---
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. In ac euismod odio, eu consequat dui. Nullam molestie consectetur risus id imperdiet. Proin sodales ornare turpis, non mollis massa ultricies id. Nam at nibh scelerisque, feugiat ante non, dapibus tortor. Vivamus volutpat diam quis tellus elementum bibendum. Praesent semper gravida velit quis aliquam. Etiam in cursus neque. Nam lectus ligula, malesuada et mauris a, bibendum faucibus mi. Phasellus ut interdum felis. Phasellus in odio pulvinar, porttitor urna eget, fringilla lectus. Aliquam sollicitudin est eros. Mauris consectetur quam vitae mauris interdum hendrerit. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+
+Duis et egestas libero, imperdiet faucibus ipsum. Sed posuere eget urna vel feugiat. Vivamus a arcu sagittis, fermentum urna dapibus, congue lectus. Fusce vulputate porttitor nisl, ac cursus elit volutpat vitae. Nullam vitae ipsum egestas, convallis quam non, porta nibh. Morbi gravida erat nec neque bibendum, eu pellentesque velit posuere. Fusce aliquam erat eu massa eleifend tristique.
+
+Sed consequat sollicitudin ipsum eget tempus. Integer a aliquet velit. In justo nibh, pellentesque non suscipit eget, gravida vel lacus. Donec odio ante, malesuada in massa quis, pharetra tristique ligula. Donec eros est, tristique eget finibus quis, semper non nisl. Vivamus et elit nec enim ornare placerat. Sed posuere odio a elit cursus sagittis.
+
+Phasellus feugiat purus eu tortor ultrices finibus. Ut libero nibh, lobortis et libero nec, dapibus posuere eros. Sed sagittis euismod justo at consectetur. Nulla finibus libero placerat, cursus sapien at, eleifend ligula. Vivamus elit nisl, hendrerit ac nibh eu, ultrices tempus dui. Nam tellus neque, commodo non rhoncus eu, gravida in risus. Nullam id iaculis tortor.
+
+Nullam at odio in sem varius tempor sit amet vel lorem. Etiam eu hendrerit nisl. Fusce nibh mauris, vulputate sit amet ex vitae, congue rhoncus nisl. Sed eget tellus purus. Nullam tempus commodo erat ut tristique. Cras accumsan massa sit amet justo consequat eleifend. Integer scelerisque vitae tellus id consectetur.

examples/basics/docs-examples-from-docusaurus/exampledoc4.md

@@ -0,0 +1,10 @@
+---
+id: doc4
+title: Other Document
+layout: docs-other
+category: First Category
+permalink: docs/en/doc4.html
+next: doc5
+---
+
+this is another document

examples/basics/docs-examples-from-docusaurus/exampledoc5.md

@@ -0,0 +1,10 @@
+---
+id: doc5
+title: Fifth Document
+layout: docs-other
+category: First Category
+permalink: docs/en/doc5.html
+previous: doc4
+---
+
+Another one