From 3a242e62ad258024894d3ad32cff06e905b39948 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Tue, 9 Mar 2021 16:05:58 +0100 Subject: [PATCH] chore(v1): release docusaurus v1.14.7 (#4372) * upgrade v1 versions * revert version + update changelog * Add 1.14.7 docs * 1.14.7 * v1.14.7 * v1.14.7 * revert private: true after v1 publish * update the v1 publish instructions a bit * revert v1 versions * mention reverting v1 versions to v2 versions... --- CHANGELOG.md | 12 + admin/publish.md | 14 +- .../version-1.14.7/api-site-config.md | 477 ++++++++++++++++++ .../version-1.14.7/getting-started-docker.md | 66 +++ .../getting-started-installation.md | 119 +++++ .../getting-started-publishing.md | 388 ++++++++++++++ .../version-1.14.7/guides-blog.md | 159 ++++++ .../version-1.14.7/guides-search.md | 84 +++ .../version-1.14.7/tutorial-create-pages.md | 99 ++++ .../version-1.14.7/tutorial-version.md | 74 +++ website-1.x/versions.json | 1 + 11 files changed, 1490 insertions(+), 3 deletions(-) create mode 100644 website-1.x/versioned_docs/version-1.14.7/api-site-config.md create mode 100644 website-1.x/versioned_docs/version-1.14.7/getting-started-docker.md create mode 100644 website-1.x/versioned_docs/version-1.14.7/getting-started-installation.md create mode 100644 website-1.x/versioned_docs/version-1.14.7/getting-started-publishing.md create mode 100644 website-1.x/versioned_docs/version-1.14.7/guides-blog.md create mode 100644 website-1.x/versioned_docs/version-1.14.7/guides-search.md create mode 100644 website-1.x/versioned_docs/version-1.14.7/tutorial-create-pages.md create mode 100644 website-1.x/versioned_docs/version-1.14.7/tutorial-version.md diff --git a/CHANGELOG.md b/CHANGELOG.md index dea2404d5d05..9188e9b0cbf1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +## [1.14.7] - 2021-03-09 + +#### :house: Internal + +- `docusaurus-1.x` + + - [#4270](https://github.com/facebook/docusaurus/pull/4270) chore: upgrade react-dev-utils ([@yangshun](https://github.com/yangshun)) + +#### Committers: 1 + +- Yangshun Tay ([@yangshun](https://github.com/yangshun)) + ## [1.14.6] - 2020-08-05 #### :bug: Bug Fix diff --git a/admin/publish.md b/admin/publish.md index 5a284a5c4b91..2f35f72757eb 100644 --- a/admin/publish.md +++ b/admin/publish.md @@ -243,7 +243,13 @@ https://github.com/facebook/docusaurus/releases/tag/%VER% **TLDR**: you need to mark them as public, publish, and mark them back as private -v1 packages have been marked as `private: true` on purpose. This is because lerna will publish ALL (v1+v2) packages with the lerna-publish command. Unfortunately it seems therre is no way to tell it to ignore v1 packages while publishing v2. During a long time, we published all these packages using the @next dist tag: `yarn lerna publish 2.0.0-alpha.41 --dist-tag next --exact` But it cause problems because v2 packages will then all need @next during npm/yarn installs, confusing some users (https://github.com/facebook/docusaurus/issues/3755) We made the v1 packages private so that lerna publish won't publish them, so that we can publish v2 packages under latest dist tag, without creating v1 upgrades that people will be notified abut. +v1 packages have been marked as `private: true` on purpose. This is because lerna will publish ALL (v1+v2) packages with the lerna-publish command. + +Unfortunately it seems there is no way to tell it to ignore v1 packages while publishing v2. + +During a long time, we published all these packages using the `@next` dist tag: `yarn lerna publish 2.0.0-alpha.41 --dist-tag next --exact`. It caused problems because v2 packages will then all need @next during npm/yarn installs, confusing some users (https://github.com/facebook/docusaurus/issues/3755). + +We made the v1 packages private so that lerna publish won't publish them, so that we can publish v2 packages under latest dist tag, without creating v1 upgrades that people will be notified abut. ### Updated v1 release process @@ -259,8 +265,9 @@ Suppose we are at `v1.14.5`, and want to release `v1.14.6`: - Run `yarn install` - Version the docs: `yarn workspace docusaurus-1-website docusaurus-version 1.14.6` - Test the v1 website locally: `yarn start:v1` + `yarn build:v1` -- Make the v1 package private: false -- Publish: `yarn workspace docusaurus publish --new-version 1.14.6` +- Make the two v1 packages private: false +- Publish: `yarn workspace docusaurus-init publish --no-git-tag-version --new-version 1.14.6` +- Publish: `yarn workspace docusaurus publish --no-git-tag-version --new-version 1.14.6` - Make the v1 package private: true The release is now published. It's worth to test it by initializing a new v1 site: @@ -279,6 +286,7 @@ Finish the release: - Push: `git push origin slorber/release-1.14.6` - Run `git tag v1.14.6` (important: the tag is prefixed by **`v`**) - Run `git push origin v1.14.6` +- Ensure you can run `yarn install` (it may fail and need to use v2 versions on the v1 packages...) - Open a PR, and merge it - Create the [new Github release](https://github.com/facebook/docusaurus/releases/new), paste the changelog - The End diff --git a/website-1.x/versioned_docs/version-1.14.7/api-site-config.md b/website-1.x/versioned_docs/version-1.14.7/api-site-config.md new file mode 100644 index 000000000000..596942c8f067 --- /dev/null +++ b/website-1.x/versioned_docs/version-1.14.7/api-site-config.md @@ -0,0 +1,477 @@ +--- +id: version-1.14.7-site-config +title: siteConfig.js +original_id: site-config +--- + +A large part of the site configuration is done by editing the `siteConfig.js` file. + +## User Showcase + +The `users` array is used to store objects for each project/user that you want to show on your site. Currently, this field is used by the example `pages/en/index.js` and `pages/en/users.js` files provided. Each user object should have `caption`, `image`, `infoLink`, and `pinned` fields. The `caption` is the text showed when someone hovers over the `image` of that user, and the `infoLink` is where clicking the image will bring someone. The `pinned` field determines whether or not it shows up on the `index` page. + +Currently, this `users` array is used only by the `index.js` and `users.js` example files. If you do not wish to have a users page or show users on the `index` page, you may remove this section. + +## siteConfig Fields + +The `siteConfig` object contains the bulk of the configuration settings for your website. + +### Mandatory Fields + +#### `baseUrl` [string] + +baseUrl for your site. This can also be considered the path after the host. For example, `/metro/` is the baseUrl of https://facebook.github.io/metro/. For URLs that have no path, the baseUrl should be set to `/`. This field is related to the [`url` field](#url-string). + +#### `colors` [object] + +Color configurations for the site. + +- `primaryColor` is the color used the header navigation bar and sidebars. +- `secondaryColor` is the color seen in the second row of the header navigation bar when the site window is narrow (including on mobile). +- Custom color configurations can also be added. For example, if user styles are added with colors specified as `$myColor`, then adding a `myColor` field to `colors` will allow you to configure this color. + +#### `copyright` [string] + +The copyright string at the footer of the site and within the feed + +#### `favicon` [string] + +URL for site favicon. + +#### `headerIcon` [string] + +URL for icon used in the header navigation bar. + +#### `headerLinks` [array] + +Links that will be used in the header navigation bar. The `label` field of each object will be the link text and will also be translated for each language. + +Example Usage: + +```js +headerLinks: [ + // Links to document with id doc1 for current language/version + { doc: "doc1", label: "Getting Started" }, + // Link to page found at pages/en/help.js or if that does not exist, pages/help.js, for current language + { page: "help", label: "Help" }, + // Links to href destination, using target=_blank (external) + { href: "https://github.com/", label: "GitHub", external: true }, + // Links to blog generated by Docusaurus (${baseUrl}blog) + { blog: true, label: "Blog" }, + // Determines search bar position among links + { search: true }, + // Determines language drop down position among links + { languages: true } +], +``` + +#### `organizationName` [string] + +GitHub username of the organization or user hosting this project. This is used by the publishing script to determine where your GitHub pages website will be hosted. + +#### `projectName` [string] + +Project name. This must match your GitHub repository project name (case-sensitive). + +#### `tagline` [string] + +The tagline for your website. + +#### `title` [string] + +Title for your website. + +#### `url` [string] + +URL for your website. This can also be considered the top-level hostname. For example, `https://facebook.github.io` is the URL of https://facebook.github.io/metro/, and `https://docusaurus.io` is the URL for https://docusaurus.io. This field is related to the [`baseUrl` field](#baseurl-string). + +### Optional Fields + +#### `algolia` [object] + +Information for Algolia search integration. If this field is excluded, the search bar will not appear in the header. You must specify two values for this field, and one (`appId`) is optional. + +- `apiKey` - the Algolia provided an API key for your search. +- `indexName` - the Algolia provided index name for your search (usually this is the project name) +- `appId` - Algolia provides a default scraper for your docs. If you provide your own, you will probably get this id from them. + +#### `blogSidebarCount` [number] + +Control the number of blog posts that show up in the sidebar. See the [adding a blog docs](guides-blog.md#changing-how-many-blog-posts-show-on-sidebar) for more information. + +#### `blogSidebarTitle` [string] + +Control the title of the blog sidebar. See the [adding a blog docs](guides-blog.md#changing-the-sidebar-title) for more information. + +#### `cleanUrl` [boolean] + +If `true`, allow URLs with no `HTML` extension. For example, a request to URL https://docusaurus.io/docs/installation will return the same result as https://docusaurus.io/docs/installation.html. + +> If users intend for this website to be used exclusively offline, this value must be set to `false`. Otherwise, it will cause the site to route to the parent folder of the linked page. + +#### `cname` [string] + +The CNAME for your website. It will go into a `CNAME` file when your site is built. + +#### `customDocsPath` [string] + +By default, Docusaurus expects your documentation to be in a directory called `docs`. This directory is at the same level as the `website` directory (i.e., not inside the `website` directory). You can specify a custom path to your documentation with this field. + +```js +customDocsPath: 'docs/site'; +``` + +```js +customDocsPath: 'website-docs'; +``` + +#### `defaultVersionShown` [string] + +The default version for the site to be shown. If this is not set, the latest version will be shown. + +#### `deletedDocs` [object] + +Even if you delete the main file for a documentation page and delete it from your sidebar, the page will still be created for every version and for the current version due to [fallback functionality](versioning#fallback-functionality). This can lead to confusion if people find the documentation by searching and it appears to be something relevant to a particular version but actually is not. + +To force removal of content beginning with a certain version (including for current/next), add a `deletedDocs` object to your config, where each key is a version and the value is an array of document IDs that should not be generated for that version and all later versions. + +Example: + +```js +{ + deletedDocs: { + "2.0.0": [ + "tagging" + ] + } +} +``` + +The version keys must match those in `versions.json`. Assuming the versions list in `versions.json` is `["3.0.0", "2.0.0", "1.1.0", "1.0.0"]`, the `docs/1.0.0/tagging` and `docs/1.1.0/tagging` URLs will work but `docs/2.0.0/tagging`, `docs/3.0.0/tagging`, and `docs/tagging` will not. The files and folders for those versions will not be generated during the build. + +#### `docsUrl` [string] + +The base URL for all docs file. Set this field to `''` to remove the `docs` prefix of the documentation URL. If unset, it is defaulted to `docs`. + +#### `disableHeaderTitle` [boolean] + +An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to `true`. + +#### `disableTitleTagline` [boolean] + +An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as `Title • Tagline`. Set to `true` to make page titles just `Title`. + +#### `docsSideNavCollapsible` [boolean] + +Set this to `true` if you want to be able to expand/collapse the links and subcategories in the sidebar. + +#### `editUrl` [string] + +URL for editing docs, usage example: `editUrl + 'en/doc1.md'`. If this field is omitted, there will be no "Edit this Doc" button for each document. + +#### `enableUpdateBy` [boolean] + +An option to enable the docs showing the author who last updated the doc. Set to `true` to show a line at the bottom right corner of each doc page as `Last updated by `. + +#### `enableUpdateTime` [boolean] + +An option to enable the docs showing last update time. Set to `true` to show a line at the bottom right corner of each doc page as `Last updated on `. + +#### `facebookAppId` [string] + +If you want Facebook Like/Share buttons in the footer and at the bottom of your blog posts, provide a [Facebook application id](https://www.facebook.com/help/audiencenetwork/804209223039296). + +#### `facebookComments` [boolean] + +Set this to `true` if you want to enable Facebook comments at the bottom of your blog post. `facebookAppId` has to be also set. + +#### `facebookPixelId` [string] + +[Facebook Pixel](https://www.facebook.com/business/a/facebook-pixel) ID to track page views. + +#### `fonts` [object] + +Font-family CSS configuration for the site. If a font family is specified in `siteConfig.js` as `$myFont`, then adding a `myFont` key to an array in `fonts` will allow you to configure the font. Items appearing earlier in the array will take priority of later elements, so ordering of the fonts matter. + +In the below example, we have two sets of font configurations, `myFont` and `myOtherFont`. `Times New Roman` is the preferred font in `myFont`. `-apple-system` is the preferred in `myOtherFont`. + +```js +fonts: { + myFont: [ + 'Times New Roman', + 'Serif' + ], + myOtherFont: [ + '-apple-system', + 'system-ui' + ] +}, +``` + +The above fonts would be represented in your CSS file(s) as variables `$myFont` and `$myOtherFont`. + +```css +h1 { + font-family: $myFont; +} +``` + +#### `footerIcon` [string] + +URL for a footer icon. Currently used in the `core/Footer.js` file provided as an example, but it can be removed from that file. + +#### `gaTrackingId` [string] + +Google Analytics tracking ID to track page views. + +#### `gaGtag` [boolean] + +Set this to `true` if you want to use [global site tags (gtag.js)](https://developers.google.com/gtagjs/) for Google analytics instead of `analytics.js`. + +#### `githubHost` [string] + +The hostname of your server. Useful if you are using GitHub Enterprise. + +#### `highlight` + +[Syntax highlighting](api-doc-markdown.md) options: + +```js +{ + // ... + highlight: { + // The name of the theme used by Highlight.js when highlighting code. + // You can find the list of supported themes here: + // https://github.com/isagalaev/highlight.js/tree/master/src/styles + theme: 'default', + + // The particular version of Highlight.js to be used. + version: '9.12.0', + + // Escape valve by passing an instance of Highlight.js to the function specified here, allowing additional languages to be registered for syntax highlighting. + hljs: function(highlightJsInstance) { + // do something here + }, + + // Default language. + // It will be used if one is not specified at the top of the code block. You can find the list of supported languages here: + // https://github.com/isagalaev/highlight.js/tree/master/src/languages + + defaultLang: 'javascript', + + // custom URL of CSS theme file that you want to use with Highlight.js. If this is provided, the `theme` and `version` fields will be ignored. + themeUrl: 'http://foo.bar/custom.css' + }, +} +``` + +#### `manifest` [string] + +Path to your web app manifest (e.g., `manifest.json`). This will add a `` tag to `` with `rel` as `"manifest"` and `href` as the provided path. + +#### `markdownOptions` [object] + +Override default [Remarkable options](https://github.com/jonschlinkert/remarkable#options) that will be used to render markdown. + +> To manage [syntax extensions](https://github.com/jonschlinkert/remarkable#syntax-extensions), use the `markdownPlugins` field. + +#### `markdownPlugins` [array] + +An array of plugins to be loaded by Remarkable, the markdown parser and renderer used by Docusaurus. The plugin will receive a reference to the Remarkable instance, allowing custom parsing and rendering rules to be defined. + +For example, if you want to [enable superscript and subscript](https://github.com/jonschlinkert/remarkable#syntax-extensions) in your markdown that is rendered by Remarkable to HTML, you would do the following: + +``` + markdownPlugins: [ + function foo(md) { + md.inline.ruler.enable(['sub', 'sup']); + }, + ], +``` + +#### `noIndex` [boolean] + +Boolean. If true, Docusaurus will politely ask crawlers and search engines to avoid indexing your site. This is done with a header tag and so only applies to docs and pages. Will not attempt to hide static resources. This is a best effort request. Malicious crawlers can and will still index your site. + +#### `ogImage` [string] + +Local path to an Open Graph image (e.g., `img/myImage.png`). This image will show up when your site is shared on Facebook and other websites/apps where the Open Graph protocol is supported. + +#### `onPageNav` [string] + +If you want a visible navigation option for representing topics on the current page. Currently, there is one accepted value for this option: + +- `separate` - The secondary navigation is a separate pane defaulting on the right side of a document. See http://docusaurus.io/docs/en/translation.html for an example. + +#### `scripts` [array] + +An array of JavaScript sources to load. The values can be either strings or plain objects of attribute-value maps. Refer to the example below. The script tag will be inserted in the HTML head. + +#### `separateCss` [array] + +Directories inside which any `CSS` files will not be processed and concatenated to Docusaurus' styles. This is to support static `HTML` pages that may be separate from Docusaurus with completely separate styles. + +#### `scrollToTop` [boolean] + +Set this to `true` if you want to enable the scroll to top button at the bottom of your site. + +#### `scrollToTopOptions` [object] + +Optional options configuration for the scroll to top button. You do not need to use this, even if you set `scrollToTop` to `true`; it just provides you more configuration control of the button. You can find more options [here](https://github.com/vfeskov/vanilla-back-to-top/blob/v7.1.14/OPTIONS.md). By default, we set the zIndex option to 100. + +#### `slugPreprocessor` [function] + +Define the slug preprocessor function if you want to customize the text used for generating the hash links. Function provides the base string as the first argument and must always return a string. + +#### `stylesheets` [array] + +An array of CSS sources to load. The values can be either strings or plain objects of attribute-value maps. The link tag will be inserted in the HTML head. + +#### `translationRecruitingLink` [string] + +URL for the `Help Translate` tab of language selection when languages besides English are enabled. This can be included you are using translations but does not have to be. + +#### `twitter` [boolean] + +Set this to `true` if you want a Twitter social button to appear at the bottom of your blog posts. + +#### `twitterUsername` [string] + +If you want a Twitter follow button at the bottom of your page, provide a Twitter username to follow. For example: `docusaurus`. + +#### `twitterImage` [string] + +Local path to your Twitter card image (e.g., `img/myImage.png`). This image will show up on the Twitter card when your site is shared on Twitter. + +#### `useEnglishUrl` [string] + +If you do not have [translations](guides-translation.md) enabled (e.g., by having a `languages.js` file), but still want a link of the form `/docs/en/doc.html` (with the `en`), set this to `true`. + +#### `users` [array] + +The `users` array mentioned earlier. + +#### `usePrism` [array] + +An array of languages to use Prism syntax highlighter. Refer to [Using Prism as additional syntax highlighter](api-doc-markdown.md#using-prism-as-additional-syntax-highlighter). Set it to `true` to use Prism on all languages. + +#### `wrapPagesHTML` [boolean] + +Boolean flag to indicate whether `HTML` files in `/pages` should be wrapped with Docusaurus site styles, header and footer. This feature is experimental and relies on the files being `HTML` fragments instead of complete pages. It inserts the contents of your `HTML` file with no extra processing. Defaults to `false`. + +Users can also add their own custom fields if they wish to provide some data across different files. + +## Adding Google Fonts + + + +Google Fonts offers faster load times by caching fonts without forcing users to sacrifice privacy. For more information on Google Fonts, see the [Google Fonts](https://fonts.google.com/) documentation. + +To add Google Fonts to your Docusaurus deployment, add the font path to the `siteConfig.js` under `stylesheets`: + +```js +stylesheets: [ + 'https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,700', +], +``` + +## Example siteConfig.js with many available fields + +```js +const users = [ + { + caption: 'User1', + image: '/test-site/img/docusaurus.svg', + infoLink: 'https://www.example.com', + pinned: true, + }, +]; + +const siteConfig = { + title: 'Docusaurus', + tagline: 'Generate websites!', + url: 'https://docusaurus.io', + baseUrl: '/', + // For github.io type URLS, you would combine the URL and baseUrl like: + // url: 'https://reasonml.github.io', + // baseUrl: '/reason-react/', + defaultVersionShown: '1.0.0', + organizationName: 'facebook', + projectName: 'docusaurus', + noIndex: false, + // For no header links in the top nav bar -> headerLinks: [], + headerLinks: [ + {doc: 'doc1', label: 'Docs'}, + {page: 'help', label: 'Help'}, + {search: true}, + {blog: true}, + ], + headerIcon: 'img/docusaurus.svg', + favicon: 'img/favicon.png', + colors: { + primaryColor: '#2E8555', + secondaryColor: '#205C3B', + }, + editUrl: 'https://github.com/facebook/docusaurus/edit/master/docs/', + // Users variable set above + users, + disableHeaderTitle: true, + disableTitleTagline: true, + separateCss: ['static/css/non-docusaurus', 'static/assets/separate-css'], + footerIcon: 'img/docusaurus.svg', + translationRecruitingLink: 'https://crowdin.com/project/docusaurus', + algolia: { + apiKey: '0f9f28b9ab9efae89810921a351753b5', + indexName: 'github', + }, + gaTrackingId: 'UA-12345678-9', + highlight: { + theme: 'default', + }, + markdownPlugins: [ + function foo(md) { + md.renderer.rules.fence_custom.foo = function ( + tokens, + idx, + options, + env, + instance, + ) { + return '
bar
'; + }; + }, + ], + scripts: [ + 'https://docusaurus.io/slash.js', + { + src: + 'https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js', + async: true, + }, + ], + stylesheets: [ + 'https://docusaurus.io/style.css', + { + href: 'http://css.link', + type: 'text/css', + }, + ], + facebookAppId: '1615782811974223', + facebookComments: true, + facebookPixelId: '352490515235776', + twitter: 'true', + twitterUsername: 'docusaurus', + twitterImage: 'img/docusaurus.png', + ogImage: 'img/docusaurus.png', + cleanUrl: true, + scrollToTop: true, + scrollToTopOptions: { + zIndex: 100, + }, + // Remove the HTML tags and HTML tags content before generating the slug + slugPreprocessor: (slugBase) => + slugBase.replace(/<([^>]+?)([^>]*?)>(.*?)<\/\1>/gi, ''), +}; + +module.exports = siteConfig; +``` diff --git a/website-1.x/versioned_docs/version-1.14.7/getting-started-docker.md b/website-1.x/versioned_docs/version-1.14.7/getting-started-docker.md new file mode 100644 index 000000000000..d12f58886f6b --- /dev/null +++ b/website-1.x/versioned_docs/version-1.14.7/getting-started-docker.md @@ -0,0 +1,66 @@ +--- +id: version-1.14.7-docker +title: Docker +original_id: docker +--- + +[Docker](https://www.docker.com/) is a tool that enables you to create, deploy, and manage lightweight, stand-alone packages that contain everything needed to run an application. It can help us to avoid conflicting dependencies & unwanted behavior when running Docusaurus. + +## Run the local web server in docker + +Ensure you have previously installed [docker](https://www.docker.com/get-started). + +To run the local web server: + +1. **Build the docker image** -- Enter the folder where you have Docusaurus installed. Run `docker build -t docusaurus-doc .` + + Once the build phase finishes, you can verify the image exists by running `docker images`. + + > We now include a `Dockerfile` when you install Docusaurus. + +2. **Run the Docusaurus container** -- To start docker run `docker run --rm -p 3000:3000 docusaurus-doc` + + This will start a docker container with the image `docusaurus-doc`. To see more detailed container info run `docker ps` . + +To access Docusaurus from outside the docker container you must add the `--host` flag to the `docusaurus-start` command as described in: [API Commands](api-commands.md#docusaurus-start) + +## Use docker-compose + +We can also use `docker-compose` to configure our application. This feature of docker allows you to run the web server and any additional services with a single command. + +> Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration. + +Using Compose is a three-step process: + +1. Define your app’s environment with a Dockerfile so it can be reproduced anywhere. + +2. Define the services that make up your app in `docker-compose.yml` so they can be run together in an isolated environment. + +3. Run `docker-compose up` and Compose starts and runs your entire app. + +We include a basic `docker-compose.yml` in your project: + +```yml +version: '3' + +services: + docusaurus: + build: . + ports: + - 3000:3000 + - 35729:35729 + volumes: + - ./docs:/app/docs + - ./website/blog:/app/website/blog + - ./website/core:/app/website/core + - ./website/i18n:/app/website/i18n + - ./website/pages:/app/website/pages + - ./website/static:/app/website/static + - ./website/sidebars.json:/app/website/sidebars.json + - ./website/siteConfig.js:/app/website/siteConfig.js + working_dir: /app/website +``` + +To run a local web server with `docker-compose` run `docker-compose up`. + +To build static HTML pages for publishing run `docker-compose run docusaurus bash -c 'yarn publish-gh-pages'` diff --git a/website-1.x/versioned_docs/version-1.14.7/getting-started-installation.md b/website-1.x/versioned_docs/version-1.14.7/getting-started-installation.md new file mode 100644 index 000000000000..4a650e45fc1a --- /dev/null +++ b/website-1.x/versioned_docs/version-1.14.7/getting-started-installation.md @@ -0,0 +1,119 @@ +--- +id: version-1.14.7-installation +title: Installation +description: Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly! +original_id: installation +--- + +Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly. + +> **Important Note:** we highly encourage you to use [Docusaurus 2](https://v2.docusaurus.io) instead. + +## Installing Docusaurus + +We have created a helpful script that will get all of the infrastructure set up for you: + +1. Ensure you have the latest version of [Node](https://nodejs.org/en/download/) installed. We also recommend you install [Yarn](https://yarnpkg.com/en/docs/install) as well. + + > You have to be on Node >= 10.9.0 and Yarn >= 1.5. + +1. Create a project, if none exists, and change your directory to this project's root. + + You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: `docs` and `website`. + + > Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus. + +1. Run the Docusaurus installation script: `npx docusaurus-init`. + + > If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run `yarn global add docusaurus-init` or `npm install --global docusaurus-init`. After that, run `docusaurus-init`. + +## Verifying Installation + +Along with previously existing files and directories, your root directory will now contain a structure similar to: + +```bash +root-directory +├── Dockerfile +├── README.md +├── docker-compose.yml +├── docs +│ ├── doc1.md +│ ├── doc2.md +│ ├── doc3.md +│ ├── exampledoc4.md +│ └── exampledoc5.md +└── website + ├── blog + │ ├── 2016-03-11-blog-post.md + │ ├── 2017-04-10-blog-post-two.md + │ ├── 2017-09-25-testing-rss.md + │ ├── 2017-09-26-adding-rss.md + │ └── 2017-10-24-new-version-1.0.0.md + ├── core + │ └── Footer.js + ├── package.json + ├── pages + ├── sidebars.json + ├── siteConfig.js + └── static +``` + +> This installation creates some Docker files that are not necessary to run docusaurus. They may be deleted without issue in the interest of saving space. For more information on Docker, please see the [Docker documentation](https://docs.docker.com/). + +## Running the example website + +After running the Docusaurus initialization script, `docusaurus-init` as described in the [Installation](#installing-docusaurus) section, you will have a runnable, example website to use as your site's base. To run: + +1. `cd website` +1. From within the `website` directory, run the local web server using `yarn start` or `npm start`. +1. Load the example site at http://localhost:3000 if it did not already open automatically. If port 3000 has already been taken, another port will be used. Look at the console messages to see which. + + You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the `website` directory will cause the page to refresh. A randomly generated primary and secondary theme color will be picked for you. + +![](/img/getting-started-preparation-verify.png) + +### Launching the server behind a proxy + +If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the `NO_PROXY` environment variable. + +```sh +SET NO_PROXY=localhost +yarn start (or npm run start) +``` + +## Updating Your Docusaurus Version + +At any time after Docusaurus is installed, you can check your current version of Docusaurus by going into the `website` directory and typing `yarn outdated docusaurus` or `npm outdated docusaurus`. + +You will see something like this: + +``` +$ yarn outdated +Using globally installed version of Yarn +yarn outdated v1.5.1 +warning package.json: No license field +warning No license field +info Color legend : + "" : Major Update backward-incompatible updates + "" : Minor Update backward-compatible features + "" : Patch Update backward-compatible bug fixes +Package Current Wanted Latest Package Type URL +docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/docusaurus#readme +✨ Done in 0.41s. +``` + +> If there is no noticeable version output from the `outdated` commands, then you are up-to-date. + +You can update to the [latest version](https://www.npmjs.com/package/docusaurus) of Docusaurus by: + +``` +yarn upgrade docusaurus --latest +``` + +or + +``` +npm update docusaurus +``` + +> If you are finding that you are getting errors after your upgrade, try to either clear your Babel cache (usually it's in a [temporary directory](https://babeljs.io/docs/en/babel-register/#environment-variables) or run the Docusaurus server (e.g., `yarn start`) with the `BABEL_DISABLE_CACHE=1` environment configuration. diff --git a/website-1.x/versioned_docs/version-1.14.7/getting-started-publishing.md b/website-1.x/versioned_docs/version-1.14.7/getting-started-publishing.md new file mode 100644 index 000000000000..28c93a295aa8 --- /dev/null +++ b/website-1.x/versioned_docs/version-1.14.7/getting-started-publishing.md @@ -0,0 +1,388 @@ +--- +id: version-1.14.7-publishing +title: Publishing your site +original_id: publishing +--- + +You should now have a [site up and running locally](getting-started-site-creation.md). Once you have [customized](api-site-config.md) it to your liking, it's time to publish it. Docusaurus generates a static HTML website that is ready to be served by your favorite web server or online hosting solution. + +## Building Static HTML Pages + +To create a static build of your website, run the following script from the `website` directory: + +```bash +yarn run build # or `npm run build` +``` + +This will generate a `build` directory inside the `website` directory containing the `.html` files from all of your docs and other pages included in `pages`. + +## Hosting Static HTML Pages + +At this point, you can grab all of the files inside the `website/build` directory and copy them over to your favorite web server's `html` directory. + +> For example, both Apache and Nginx serve content from `/var/www/html` by default. That said, choosing a web server or provider is outside the scope of Docusaurus. + +> When serving the site from your own web server, ensure the web server is serving the asset files with the proper HTTP headers. CSS files should be served with the `content-type` header of `text/css`. In the case of Nginx, this would mean setting `include /etc/nginx/mime.types;` in your `nginx.conf` file. See [this issue](https://github.com/facebook/docusaurus/issues/602) for more info. + +### Hosting on a Service: + +- [Vercel](#using-vercel) +- [GitHub Pages](#using-github-pages) +- [Netlify](#hosting-on-netlify) +- [Render](#hosting-on-render) + +### Using Vercel + +Deploying your Docusaurus project to [Vercel](https://vercel.com) will provide you with various benefits in the areas of performance and ease of use. + +Most importantly, however, deploying a Docusaurus project only takes a couple of seconds: + +1. First, install their [command-line interface](https://vercel.com/download): + +```bash +npm i -g vercel +``` + +2. Run a single command inside the root directory of your project: + +```bash +vercel +``` + +**That's all.** Your docs will automatically be deployed. + +> Note that the directory structure Now supports is slightly different from the default directory structure of a Docusaurus project - The `docs` directory has to be within the `website` directory, ideally following the directory structure in this example. You will also have to specify a `customDocsPath` value in `siteConfig.js`. Take a look at the [now-examples repository for a Docusaurus project](https://github.com/vercel/vercel/tree/master/examples/docusaurus). + +### Using GitHub Pages + +Docusaurus was designed to work well with one of the most popular hosting solutions for open source projects: [GitHub Pages](https://pages.github.com/). + +#### Deploying to GitHub Pages + +1. Docusaurus supports deploying as [project pages or user/organization pages](https://help.github.com/articles/user-organization-and-project-pages), your code repository does not even need to be public. + +> Even if your repository is private, anything published to a `gh-pages` branch will be [public](https://help.github.com/articles/user-organization-and-project-pages/). + +**Note:** When you deploy as user/organization page, the publish script will deploy these sites to the root of the **`master`** branch of the _username_.github.io repo. In this case, note that you will want to have the Docusaurus infra, your docs, etc. either in **another branch of the _username_.github.io repo** (e.g., maybe call it `source`), or in another, separate repo (e.g. in the same as the documented source code). + +2. You will need to modify the file `website/siteConfig.js` and add the required parameters. + +| Name | Description | +| --- | --- | +| `organizationName` | The GitHub user or organization that owns the repository. If you are the owner, then it is your GitHub username. In the case of Docusaurus, that would be the "_facebook_" GitHub organization. | +| `projectName` | The name of the GitHub repository for your project. For example, the source code for Docusaurus is hosted at https://github.com/facebook/docusaurus, so our project name, in this case, would be "docusaurus". | +| `url` | Your website's URL. For projects hosted on GitHub pages, this will be "https://_username_.github.io" | +| `baseUrl` | Base URL for your project. For projects hosted on GitHub pages, it follows the format "/_projectName_/". For https://github.com/facebook/docusaurus, `baseUrl` is `/docusaurus/`. | + +```js +const siteConfig = { + ... + url: 'https://__userName__.github.io', // Your website URL + baseUrl: '/testProject/', + projectName: 'testProject', + organizationName: 'userName' + ... +} +``` + +In case you want to deploy as a user or organization site, specify the project name as `.github.io` or `.github.io`. E.g. If your GitHub username is "user42" then _user42.github.io_, or in the case of an organization name of "org123", it will be _org123.github.io_. + +**Note:** Not setting the `url` and `baseUrl` of your project might result in incorrect file paths generated which can cause broken links to assets paths like stylesheets and images. + +> While we recommend setting the `projectName` and `organizationName` in `siteConfig.js`, you can also use environment variables `ORGANIZATION_NAME` and `PROJECT_NAME`. + +3. Now you have to specify the git user as an environment variable, and run the script [`publish-gh-pages`](./api-commands.md#docusaurus-publish) + +| Name | Description | +| --- | --- | +| `GIT_USER` | The username for a GitHub account that has to commit access to this repo. For your repositories, this will usually be your own GitHub username. The specified `GIT_USER` must have push access to the repository specified in the combination of `organizationName` and `projectName`. | + +To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. + +**Bash** + +```bash +GIT_USER= \ + CURRENT_BRANCH=master \ + USE_SSH=true \ + yarn run publish-gh-pages # or `npm run publish-gh-pages` +``` + +**Windows** + +```batch +cmd /C "set "GIT_USER="&& set CURRENT_BRANCH=master && set USE_SSH=true && yarn run publish-gh-pages" +``` + +There are also two optional parameters that are set as environment variables: + +| Name | Description | +| --- | --- | +| `USE_SSH` | If this is set to `true`, then SSH is used instead of HTTPS for the connection to the GitHub repo. HTTPS is the default if this variable is not set. | +| `CURRENT_BRANCH` | The branch that contains the latest docs changes that will be deployed. Usually, the branch will be `master`, but it could be any branch (default or otherwise) except for `gh-pages`. If nothing is set for this variable, then the current branch will be used. | + +If you run into issues related to SSH keys, visit [GitHub's authentication documentation](https://help.github.com/articles/connecting-to-github-with-ssh/). + +You should now be able to load your website by visiting its GitHub Pages URL, which could be something along the lines of https://_username_.github.io/_projectName_, or a custom domain if you have set that up. For example, Docusaurus' own GitHub Pages URL is https://facebook.github.io/Docusaurus because it is served from the `gh-pages` branch of the https://github.com/facebook/docusaurus GitHub repository. However, it can also be accessed via https://docusaurus.io/, via a generated `CNAME` file which can be configured via the `cname` [siteConfig option](api-site-config.md#cname-string). + +We highly encourage reading through the [GitHub Pages documentation](https://pages.github.com) to learn more about how this hosting solution works. + +You can run the command above any time you update the docs and wish to deploy the changes to your site. Running the script manually may be fine for sites where the documentation rarely changes and it is not too much of an inconvenience to remember to manually deploy changes. + +However, you can automate the publishing process with continuous integration (CI). + +## Automating Deployments Using Continuous Integration + +Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and yes, deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `publish-gh-pages` script whenever your docs get updated. In the following section, we'll be covering how to do just that using [CircleCI](https://circleci.com/), a popular continuous integration service provider. + +### Using CircleCI 2.0 + +If you haven't done so already, you can [setup CircleCI](https://circleci.com/signup/) for your open source project. Afterwards, in order to enable automatic deployment of your site and documentation via CircleCI, just configure Circle to run the `publish-gh-pages` script as part of the deployment step. You can follow the steps below to get that setup. + +1. Ensure the GitHub account that will be set as the `GIT_USER` has `write` access to the repository that contains the documentation, by checking `Settings | Collaborators & teams` in the repository. +1. Log into GitHub as the `GIT_USER`. +1. Go to https://github.com/settings/tokens for the `GIT_USER` and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/), granting it full control of private repositories through the `repository` access scope. Store this token in a safe place, making sure to not share it with anyone. This token can be used to authenticate GitHub actions on your behalf in place of your GitHub password. +1. Open your CircleCI dashboard, and navigate to the Settings page for your repository, then select "Environment variables". The URL looks like https://circleci.com/gh/ORG/REPO/edit#env-vars, where "ORG/REPO" should be replaced with your own GitHub organization/repository. +1. Create a new environment variable named `GITHUB_TOKEN`, using your newly generated access token as the value. +1. Create a `.circleci` directory and create a `config.yml` under that directory. +1. Copy the text below into `.circleci/config.yml`. + +```yaml +# If you only want the circle to run on direct commits to master, you can uncomment this out +# and uncomment the filters: *filter-only-master down below too +# +# aliases: +# - &filter-only-master +# branches: +# only: +# - master + +version: 2 +jobs: + deploy-website: + docker: + # specify the version you desire here + - image: circleci/node:8.11.1 + + steps: + - checkout + - run: + name: Deploying to GitHub Pages + command: | + git config --global user.email "@users.noreply.github.com" + git config --global user.name "" + echo "machine github.com login password $GITHUB_TOKEN" > ~/.netrc + cd website && yarn install && GIT_USER= yarn run publish-gh-pages + +workflows: + version: 2 + build_and_deploy: + jobs: + - deploy-website: +# filters: *filter-only-master +``` + +Make sure to replace all `<....>` in the `command:` sequence with appropriate values. For ``, it should be a GitHub account that has access to push documentation to your GitHub repository. Many times `` and `` will be the same. + +**DO NOT** place the actual value of `$GITHUB_TOKEN` in `circle.yml`. We already configured that as an environment variable back in Step 5. + +> If you want to use SSH for your GitHub repository connection, you can set `USE_SSH=true`. So the above command would look something like: `cd website && npm install && GIT_USER= USE_SSH=true npm run publish-gh-pages`. + +> Unlike when you run the `publish-gh-pages` script manually when the script runs within the Circle environment, the value of `CURRENT_BRANCH` is already defined as an [environment variable within CircleCI](https://circleci.com/docs/1.0/environment-variables/) and will be picked up by the script automatically. + +Now, whenever a new commit lands in `master`, CircleCI will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script. + +> If you would rather use a deploy key instead of a personal access token, you can by starting with the CircleCI [instructions](https://circleci.com/docs/1.0/adding-read-write-deployment-key/) for adding a read/write deploy key. + +### Tips & Tricks + +When initially deploying to a `gh-pages` branch using CircleCI, you may notice that some jobs triggered by commits to the `gh-pages` branch fail to run successfully due to a lack of tests (This can also result in chat/slack build failure notifications). + +You can work around this by: + +- Setting the environment variable `CUSTOM_COMMIT_MESSAGE` flag to the `publish-gh-pages` command with the contents of `[skip ci]`. e.g. + +```bash +CUSTOM_COMMIT_MESSAGE="[skip ci]" \ + yarn run publish-gh-pages # or `npm run publish-gh-pages` +``` + +- Alternatively, you can work around this by creating a basic CircleCI config with the following contents: + +```yaml +# CircleCI 2.0 Config File +# This config file will prevent tests from being run on the gh-pages branch. +version: 2 +jobs: + build: + machine: true + branches: + ignore: gh-pages + steps: + - run: echo "Skipping tests on gh-pages branch" +``` + +Save this file as `config.yml` and place it in a `.circleci` directory inside your `website/static` directory. + +### Using Travis CI + +1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) +1. Using your GitHub account, [add the Travis CI app](https://github.com/marketplace/travis-ci) to the repository you want to activate. +1. Open your Travis CI dashboard. The URL looks like https://travis-ci.com/USERNAME/REPO, and navigate to the `More options` > `Setting` > `Environment Variables` section of your repository. +1. Create a new environment variable named `GH_TOKEN` with your newly generated token as its value, then `GH_EMAIL` (your email address) and `GH_NAME` (your GitHub username). +1. Create a `.travis.yml` on the root of your repository with below text. + +```yaml +# .travis.yml +language: node_js +node_js: + - '8' +branches: + only: + - master +cache: + yarn: true +script: + - git config --global user.name "${GH_NAME}" + - git config --global user.email "${GH_EMAIL}" + - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages +``` + +Now, whenever a new commit lands in `master`, Travis CI will run your suite of tests and, if everything passes, your website will be deployed via the `publish-gh-pages` script. + +### Using Azure Pipelines + +1. Sign Up at [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/) if you haven't already. +1. Create an organization and within the organization create a project and connect your repository from GitHub. +1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) with repository scope. +1. In the project page (which looks like https://dev.azure.com/ORG_NAME/REPO_NAME/_build) create a new pipeline with the following text. Also, click on edit and add a new environment variable named `GH_TOKEN` with your newly generated token as its value, then `GH_EMAIL` (your email address) and `GH_NAME` (your GitHub username). Make sure to mark them as secret. Alternatively, you can also add a file named `azure-pipelines.yml` at yout repository root. + +```yaml +# azure-pipelines.yml +trigger: + - master + +pool: + vmImage: 'ubuntu-latest' + +steps: + - checkout: self + persistCredentials: true + + - task: NodeTool@0 + inputs: + versionSpec: '10.x' + displayName: 'Install Node.js' + + - script: | + git config --global user.name "${GH_NAME}" + git config --global user.email "${GH_EMAIL}" + git checkout -b master + echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc + cd website + yarn install + GIT_USER="${GH_NAME}" CURRENT_BRANCH=master yarn run publish-gh-pages + env: + GH_NAME: $(GH_NAME) + GH_EMAIL: $(GH_EMAIL) + GH_TOKEN: $(GH_TOKEN) + displayName: 'yarn install and build' +``` + +### Using Drone + +1. Create a new ssh key that will be the [deploy key](https://docs.github.com/en/free-pro-team@latest/developers/overview/managing-deploy-keys#deploy-keys) for your project. +1. Name your private and public keys to be specific and so that it does not overwrite your other [ssh keys](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). +1. Go to https://github.com/USERNAME/REPO/settings/keys and add a new deploy key by pasting in our public key you just generated. +1. Open your Drone.io dashboard and login. The URL looks like https://cloud.drone.io/USERNAME/REPO. +1. Click on the repository, click on activate repository, and add a secret called `git_deploy_private_key` with your private key value that you just generated. +1. Create a `.drone.yml` on the root of your repository with below text. + +```yaml +# .drone.yml +kind: pipeline +type: docker +trigger: + event: + - tag +- name: Website + image: node + commands: + - mkdir -p $HOME/.ssh + - ssh-keyscan -t rsa github.com >> $HOME/.ssh/known_hosts + - echo "$GITHUB_PRIVATE_KEY > $HOME/.ssh/id_rsa" + - chmod 0600 $HOME/.ssh/id_rsa + - cd website + - npm i + - npm run publish-gh-pages + environment: + USE_SSH: true + GIT_USER: $DRONE_COMMIT_AUTHOR + GITHUB_PRIVATE_KEY: git_deploy_private_key +``` + +Now, whenever you push a new tag to github, this trigger will start the drone ci job to publish your website. + +### Hosting on Vercel + +Deploying your Docusaurus project to [Vercel](https://vercel.com/) will provide you with [various benefits](https://vercel.com/) in the areas of performance and ease of use. + +To deploy your Docusaurus project with a [Vercel for Git Integration](https://vercel.com/docs/git-integrations), make sure it has been pushed to a Git repository. + +Import the project into Vercel using the [Import Flow](https://vercel.com/import/git). During the import, you will find all relevant options preconfigured for you; however, you can choose to change any of these options, a list of which can be found [here](https://vercel.com/docs/build-step#build-&-development-settings). + +After your project has been imported, all subsequent pushes to branches will generate [Preview Deployments](https://vercel.com/docs/platform/deployments#preview), and all changes made to the [Production Branch](https://vercel.com/docs/git-integrations#production-branch) (commonly "main") will result in a [Production Deployment](https://vercel.com/docs/platform/deployments#production). + +### Hosting on Netlify + +Steps to configure your Docusaurus-powered site on Netlify. + +1. Select **New site from Git** +1. Connect to your preferred Git provider. +1. Select the branch to deploy. Default is `master` +1. Configure your build steps: + + - For your build command enter: `cd website; npm install; npm run build;` + - For publish directory: `website/build/` (use the `projectName` from your `siteConfig`) + +1. Click **Deploy site** + +You can also configure Netlify to rebuild on every commit to your repository, or only `master` branch commits. + +### Hosting on Render + +Render offers free [static site](https://render.com/docs/static-sites) hosting with fully managed SSL, custom domains, a global CDN and continuous auto deploy from your Git repo. Deploy your app in just a few minutes by following these steps. + +1. Create a new **Web Service** on Render, and give Render's GitHub app permission to access your Docusaurus repo. + +2. Select the branch to deploy. The default is `master`. + +3. Enter the following values during creation. + + | Field | Value | + | --------------------- | -------------------------------------- | + | **Environment** | `Static Site` | + | **Build Command** | `cd website; yarn install; yarn build` | + | **Publish Directory** | `website/build/` | + + `projectName` is the value you defined in your `siteConfig.js`. + + ```javascript{7} + const siteConfig = { + // ... + projectName: 'your-project-name', + // ... + ``` + +That's it! Your app will be live on your Render URL as soon as the build finishes. + +### Publishing to GitHub Enterprise + +GitHub enterprise installations should work in the same manner as github.com; you only need to identify the organization's GitHub Enterprise host. + +| Name | Description | +| ------------- | ---------------------------------------------- | +| `GITHUB_HOST` | The hostname for the GitHub enterprise server. | + +Alter your `siteConfig.js` to add a property `'githubHost'` which represents the GitHub Enterprise hostname. Alternatively, set an environment variable `GITHUB_HOST` when executing the publish command. diff --git a/website-1.x/versioned_docs/version-1.14.7/guides-blog.md b/website-1.x/versioned_docs/version-1.14.7/guides-blog.md new file mode 100644 index 000000000000..25a7950ca6e8 --- /dev/null +++ b/website-1.x/versioned_docs/version-1.14.7/guides-blog.md @@ -0,0 +1,159 @@ +--- +id: version-1.14.7-adding-blog +title: Adding a Blog +original_id: adding-blog +--- + +## Initial Setup + +To setup your site's blog, start by creating a `blog` directory within your repo's `website` directory. + +Then, add a header link to your blog within `siteConfig.js`: + +```js +headerLinks: [ + ... + { blog: true, label: 'Blog' }, + ... +] +``` + +## Adding Posts + +To publish in the blog, create a file within the blog directory with a formatted name of `YYYY-MM-DD-my-blog-post-title.md`. The post date is extracted from the file name. + +For example, at `website/blog/2017-12-14-introducing-docusaurus.md`: + +```yml +--- +title: Introducing Docusaurus +author: Joel Marcey +authorURL: http://twitter.com/JoelMarcey +authorFBID: 611217057 +authorTwitter: JoelMarcey +--- +Lorem Ipsum... +``` + +Adding slug will override the url of the blog post. + +For example: + +```yml +--- +slug: introducing-docusaurus +title: Introducing Docusaurus +author: Joel Marcey +authorURL: http://twitter.com/JoelMarcey +authorFBID: 611217057 +authorTwitter: JoelMarcey +--- +Lorem Ipsum... +``` + +Will be available at `https://website/blog/introducing-docusaurus` + +## Header Options + +The only required field is `title`; however, we provide options to add author information to your blog post as well along with other options. + +- `author` - The text label of the author byline. +- `authorURL` - The URL associated with the author. This could be a Twitter, GitHub, Facebook account, etc. +- `authorFBID` - The Facebook profile ID that is used to fetch the profile picture. +- `authorImageURL` - The URL to the author's image. (Note: If you use both `authorFBID` and `authorImageURL`, `authorFBID` will take precedence. Don't include `authorFBID` if you want `authorImageURL` to appear.) +- `title` - The blog post title. +- `slug` - The blog post url slug. Example: `/blog/my-test-slug`. When not specified, the blog url slug will be extracted from the file name. +- `unlisted` - The post will be accessible by directly visiting the URL but will not show up in the sidebar in the final build; during local development, the post will still be listed. Useful in situations where you want to share a WIP post with others for feedback. +- `draft` - The post will not appear if set to `true`. Useful in situations where WIP but don't want to share the post. + +## Summary Truncation + +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example: + +```yaml +--- +title: Truncation Example +--- +All this will be part of the blog post summary. + +Even this. + + + +But anything from here on down will not be. + +Not this. + +Or this. +``` + +## Changing How Many Blog Posts Show on Sidebar + +By default, 5 recent blog posts are shown on the sidebar. + +You can configure a specific amount of blog posts to show by adding a `blogSidebarCount` setting to your `siteConfig.js`. + +The available options are an integer representing the number of posts you wish to show or a string with the value `'ALL'`. + +Example: + +```js +blogSidebarCount: 'ALL', +``` + +## Changing The Sidebar Title + +You can configure a specific sidebar title by adding a `blogSidebarTitle` setting to your `siteConfig.js`. + +The option is an object which can have the keys `default` and `all`. Specifying a value for `default` allows you to change the default sidebar title. Specifying a value for `all` allows you to change the sidebar title when the `blogSidebarCount` option is set to `'ALL'`. + +Example: + +```js +blogSidebarTitle: { default: 'Recent posts', all: 'All blog posts' }, +``` + +## RSS Feed + +Docusaurus provides an RSS feed for your blog posts. Both RSS and Atom feed formats are supported. This data is automatically added to your website page's HTML `` tag. + +A summary of the post's text is provided in the RSS feed up to the ``. If no `` tag is found, then all text up to 250 characters are used. + +## Social Buttons + +If you want Facebook and/or Twitter social buttons at the bottom of your blog posts, set the `facebookAppId` and/or `twitter` [site configuration](api-site-config.md) options in `siteConfig.js`. + +## Advanced Topics + +### I want to run in "Blog Only" mode. + +You can run your Docusaurus site without a landing page and instead have your blog load first. + +To do this: + +1. Create a file `index.html` in `website/static/`. +1. Place the contents of the template below into `website/static/index.html` +1. Customize the `` of `website/static/index.html` +1. Delete the dynamic landing page `website/pages/en/index.js` + +> Now, when Docusaurus generates or builds your site, it will copy the file from `static/index.html` and place it in the site's main directory. The static file is served when a visitor arrives on your page. When the page loads, it will redirect the visitor to `/blog`. + +You can use this template: + +```html +<!DOCTYPE html> +<html lang="en-US"> + <head> + <meta charset="UTF-8" /> + <meta http-equiv="refresh" content="0; url=blog/" /> + <script type="text/javascript"> + window.location.href = 'blog/'; + </script> + <title>Title of Your Blog + + + If you are not redirected automatically, follow this + link. + + +``` diff --git a/website-1.x/versioned_docs/version-1.14.7/guides-search.md b/website-1.x/versioned_docs/version-1.14.7/guides-search.md new file mode 100644 index 000000000000..66ac38f41016 --- /dev/null +++ b/website-1.x/versioned_docs/version-1.14.7/guides-search.md @@ -0,0 +1,84 @@ +--- +id: version-1.14.7-search +title: Enabling Search +original_id: search +--- + +Docusaurus supports search using [Algolia DocSearch](https://community.algolia.com/docsearch/). Once your website is online, you can [submit it to DocSearch](https://community.algolia.com/docsearch/). Algolia will then send you credentials you can add to your `siteConfig.js`. + +DocSearch works by crawling the content of your website every 24 hours and putting all the content in an Algolia index. This content is then queried directly from your front-end using the Algolia API. Note that your website needs to be publicly available for this to work (ie. not behind a firewall). This service is free. + +## Enabling the Search Bar + +Enter your API key and index name (sent by Algolia) into `siteConfig.js` in the `algolia` section to enable search for your site. + +```js +const siteConfig = { + ... + algolia: { + apiKey: 'my-api-key', + indexName: 'my-index-name', + appId: 'app-id', // Optional, if you run the DocSearch crawler on your own + algoliaOptions: {} // Optional, if provided by Algolia + }, + ... +}; +``` + +## Extra Search Options + +You can also specify extra [search options used by Algolia](https://docsearch.algolia.com/) by using an `algoliaOptions` field in `algolia`. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be [found here](https://www.algolia.com/doc/api-reference/api-parameters/#overview). + +```js +const siteConfig = { + ... + algolia: { + ... + algoliaOptions: { + facetFilters: [ "language:LANGUAGE", "version:VERSION" ] + } + }, +}; +``` + +Algolia might provide you with [extra search options](https://docsearch.algolia.com/). If so, you should add them to the `algoliaOptions` object. + +## Controlling the Location of the Search Bar + +By default, the search bar will be the rightmost element in the top navigation bar. + +If you want to change the default location, add the `searchBar` flag in the `headerLinks` field of `siteConfig.js` in your desired location. For example, you may want the search bar between your internal and external links. + +```js +const siteConfig = { + ... + headerLinks: [ + {...} + {...} + { search: true } + {...} + {...} + ], + ... +}; +``` + +## Customizing the placeholder + +If you want to change the placeholder (which defaults to _Search_), add the `placeholder` field in your config. For example, you may want the search bar to display _Ask me something_: + +```js +const siteConfig = { + ... + algolia: { + ... + placeholder: 'Ask me something' + }, +}; +``` + +## Disabling the Search Bar + +To disable the search bar, comment out (recommended) or delete the `algolia` section in the `siteConfig.js` file. + +Also, if you have customized the location of the search bar in `headerLinks`, set `search: false`. diff --git a/website-1.x/versioned_docs/version-1.14.7/tutorial-create-pages.md b/website-1.x/versioned_docs/version-1.14.7/tutorial-create-pages.md new file mode 100644 index 000000000000..6bfad813a9e7 --- /dev/null +++ b/website-1.x/versioned_docs/version-1.14.7/tutorial-create-pages.md @@ -0,0 +1,99 @@ +--- +id: version-1.14.7-tutorial-create-pages +title: Create Pages +original_id: tutorial-create-pages +--- + +In this section, we will learn about creating two types of pages in Docusaurus: a regular page and a documentation page. + +Docusaurus MacBook + +## Create a Regular Page + +1. In the `website/pages/en` directory of your repository, save a text file called `hello-world.js` with the following contents: + +``` +const React = require('react'); + +const CompLibrary = require('../../core/CompLibrary.js'); + +const Container = CompLibrary.Container; +const GridBlock = CompLibrary.GridBlock; + +function HelloWorld(props) { + return ( +
+ +

Hello World!

+

This is my first page!

+ +
+ ); +} + +module.exports = HelloWorld; +``` + +> Use any text editor to make the file, such as [Microsoft Visual Studio Code](https://code.visualstudio.com/download) or [Komodo Edit](https://www.activestate.com/komodo-edit). + +2. Go to http://localhost:3000/hello-world and you should be able to see the new page. +1. Change the text within the `

...

` to "I can write JSX here!" and save the file again. The browser should refresh automatically to reflect the change. + +```diff +-

This is my first page!

++

I can write JSX here!

+``` + +React is being used as a templating engine for rendering static markup. You can leverage on the expressibility of React to build rich web content. Learn more about creating pages [here](custom-pages). + +Docusaurus React + +## Create a Documentation Page + +1. Create a new file in the `docs` folder called `doc9.md`. The `docs` folder is in the root of your Docusaurus project, same level as the `website` folder. +1. Paste the following contents: + +``` +--- +id: doc9 +title: This is Doc 9 +--- + +I can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/). + +## Markdown Syntax + +**Bold** _italic_ `code` [Links](#url) + +> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse +> id sem consectetuer libero luctus adipiscing. + +* Hey +* Ho +* Let's Go +``` + +3. The `sidebars.json` is where you specify the order of your documentation pages, so open `website/sidebars.json` and add `"doc9"` after `"doc1"`. This ID should be the same one as in the metadata for the Markdown file above, so if you gave a different ID in Step 2, just make sure to use the same ID in the sidebar file. + +```diff +{ + "docs": { + "Docusaurus": [ + "doc1", ++ "doc9" + ], + "First Category": ["doc2"], + "Second Category": ["doc3"] + }, + "docs-other": { + "First Category": ["doc4", "doc5"] + } +} +``` + +4. A server restart is needed to pick up sidebar changes, so go to your terminal, kill your dev server (Cmd + C or Ctrl + C), and run `npm start` or `yarn start`. +1. Navigate to http://localhost:3000/docs/doc9 to see the new documentation page. + +You've created your first documentation page on Docusaurus! + +Learn more about creating docs pages [here](navigation). diff --git a/website-1.x/versioned_docs/version-1.14.7/tutorial-version.md b/website-1.x/versioned_docs/version-1.14.7/tutorial-version.md new file mode 100644 index 000000000000..d799c985be01 --- /dev/null +++ b/website-1.x/versioned_docs/version-1.14.7/tutorial-version.md @@ -0,0 +1,74 @@ +--- +id: version-1.14.7-tutorial-version +title: Add Versions +original_id: tutorial-version +--- + +With an example site deployed, we can now try out one of the killer features of Docusaurus — versioned documentation. Versioned documentation helps to show relevant documentation for the current version of a tool and also hide unreleased documentation from users, reducing confusion. Documentation for older versions is also preserved and accessible to users of older versions of a tool even as the latest documentation changes. + +Docusaurus process + +## Releasing a Version + +Assume you are happy with the current state of the documentation and want to freeze it as the v1.0.0 docs. First you `cd` to the `website` directory and run the following command. + +```sh +npm run examples versions +``` + +That command generates a `versions.json` file, which will be used to list down all the versions of docs in the project. + +Next, you run a command with the version you want to create, like `1.0.0`. + +```sh +npm run version 1.0.0 +``` + +That command preserves a copy of all documents currently in the `docs` directory and makes them available as documentation for version 1.0.0. The `docs` directory is copied to the `website/versioned_docs/version-1.0.0` directory. + +### Current Version + +Type `npm start` and you will see the version beside the title. Version 1.0.0, the number of your current version, shows at the URL http://localhost:3000/docusaurus-tutorial/docs/doc1. + +Let's test out how versioning actually works. Open `docs/doc1.md` and change the first line of the body: + +```diff +--- +id: doc1 +title: Latin-ish +sidebar_label: Example Page +--- + +- Check the [documentation](https://docusaurus.io) for how to use Docusaurus. ++ This is the latest version of the docs. + +## Lorem + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. +``` + +If you go to http://localhost:3000/docusaurus-tutorial/docs/doc1 in your browser, realize that it's still showing the line before the change. That's because the version you're looking at is the 1.0.0 version, which has already been frozen in time. The document you changed is part of the next version. + +### Next Version + +The latest version of the documents is viewed by adding `next` to the URL: http://localhost:3000/docusaurus-tutorial/docs/next/doc1. Now you can see the line change to "This is the latest version of the docs." Note that the version beside the title changes to "next" when you open that URL. + +Click the version to open the versions page, which was created at http://localhost:3000/docusaurus-tutorial/versions with a list of the documentation versions. See that both `1.0.0` and `master` are listed there and they link to the respective versions of the documentation. + +The master documents in the `docs` directory became version next when the `website/versioned_docs/version-1.0.0` directory was made for version 1.0.0. + +### Past Versions + +Assume the documentation changed and needs an update. You can release another version, like `1.0.1`. + +```sh +npm run version 1.0.1 +``` + +Version 1.0.0 remains available as a past version. You can view it by adding `1.0.0` to the URL, http://localhost:3000/docusaurus-tutorial/docs/1.0.0/doc1. Also, a link to version 1.0.0 appears on the versions page. + +Go ahead and [publish](https://docusaurus.io/docs/en/next/tutorial-publish-site) your versioned site with the `publish-gh-pages` script! + +## Wrap Up + +That's all folks! In this short tutorial, you have experienced how easy it is to create a documentation website from scratch and make versions for them. There are many more things you can do with Docusaurus, such as adding a blog, search and translations. Check out the [Guides](https://docusaurus.io/docs/en/next/versioning) section for more. diff --git a/website-1.x/versions.json b/website-1.x/versions.json index 13e740aaf125..065526691d4b 100644 --- a/website-1.x/versions.json +++ b/website-1.x/versions.json @@ -1,4 +1,5 @@ [ + "1.14.7", "1.14.6", "1.14.5", "1.14.4",