diff --git a/docs/en/1.10.x/adding-blog.html b/docs/en/1.10.x/adding-blog.html index c5e0c17318..3c28b9b251 100644 --- a/docs/en/1.10.x/adding-blog.html +++ b/docs/en/1.10.x/adding-blog.html @@ -98,7 +98,6 @@ authorFBID: 503283835 title: Introducing Docusaurus --- - Lorem Ipsum...

Header Options

@@ -115,7 +114,6 @@ 
---
 title: Truncation Example
 ---
-
 All this will be part of the blog post summary.
 
 Even this.
@@ -160,22 +158,23 @@
 
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:

-
<!DOCTYPE HTML>
+
<!DOCTYPE html>
 <html lang="en-US">
   <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
+    <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</title>
   </head>
   <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+    If you are not redirected automatically, follow this
+    <a href="blog/">link</a>.
   </body>
 </html>
 

-
Last updated on 2019-11-11 by Eric Carboni
← DockerCustom Pages →

 
Header Options

@@ -115,7 +114,6 @@
 
---
 title: Truncation Example
 ---
-
 All this will be part of the blog post summary.
 
 Even this.
@@ -160,22 +158,23 @@
 
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:

-
<!DOCTYPE HTML>
+
<!DOCTYPE html>
 <html lang="en-US">
   <head>
-    <meta charset="UTF-8">
-    <meta http-equiv="refresh" content="0; url=blog/">
+    <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</title>
   </head>
   <body>
-    If you are not redirected automatically, follow this <a href="blog/">link</a>.
+    If you are not redirected automatically, follow this
+    <a href="blog/">link</a>.
   </body>
 </html>
 

-
Last updated on 2019-11-11 by Eric Carboni
← DockerCustom Pages →

 
This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
+
<meta property="og:description" content="My Custom Description" />
+<meta name="description" content="My Custom Description" />
 

 
Page Require Paths

 
Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

@@ -247,7 +247,7 @@ MyPage.description = 'My Custom Description';
 
There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

 
You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

 
One way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
Last updated on 2019-11-11 by Eric Carboni
← Markdown FeaturessiteConfig.js →

 
This will be translated to a description metadata tag on the generated HTML.

-
<meta property="og:description" content="My Custom Description"/>
-<meta name="description" content="My Custom Description"/>
+
<meta property="og:description" content="My Custom Description" />
+<meta name="description" content="My Custom Description" />
 

 
Page Require Paths

 
Docusaurus provides a few useful React components for users to write their own pages, found in the CompLibrary module. This module is provided as part of Docusaurus in node_modules/docusaurus, so to access it, pages in the pages directory are temporarily copied into node_modules/docusaurus when rendering to static HTML. As seen in the example files, this means that a user page at pages/en/index.js uses a require path to '../../core/CompLibrary.js' to import the provided components.

@@ -247,7 +247,7 @@ MyPage.description = 'My Custom Description';
 
There are several ways to access the default styles provided for your site. If you have started developing your website and executed the docusaurus-init or yarn install command, your default styles can be found at website/node_modules/docusaurus/lib/static/css/main.css. Alternatively, the main.css file may be inspected directly at the Docusarus GitHub repository.

 
You can provide your own custom styles by adding them anywhere in the website/static directory. Any .css files you provide in the static directory will get concatenated to the end of Docusaurus' provided styles, allowing you to add to or override Docusaurus default styles as you wish.

 
One way to figure out what classes you wish to override or add to is to start your server locally and use your browser's inspect element tool.

-
Last updated on 2019-11-11 by Eric Carboni
← Markdown FeaturessiteConfig.js →

 
Versioned documents have their ids altered to include the version number when they get copied. The new id is version-${version}-${id} where ${version} is the version number of that document and ${id} is the original id. Additionally, versioned documents get an added original_id field with the original document id.

 
For example:

@@ -103,6 +104,7 @@
 sidebar_label: Document
 original_id: doc1
 ---
+
 

 
custom_edit_url: The URL for editing this document. If this field is not present, the document's edit URL will fall back to editUrl from optional fields of siteConfig.js. See siteConfig.js docs for more information.

 
For example:

@@ -111,6 +113,7 @@
 title: Markdown Features
 custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
 ---
+

Blog Posts

Blog posts use the following markdown header fields that are enclosed by a line --- on either side:

@@ -125,6 +128,7 @@ authorURL: http://twitter.com/franchementli authorFBID: 100002976521003 --- +

Extra Features

Docusaurus supports some extra features when writing documentation in markdown.

@@ -223,7 +227,7 @@ ReactDOM.render(<h1>Hello, world!</h1>, document.getElementById('roo

Adding Copy Code Buttons

Docusaurus allows for adding buttons to copy the code within fenced code blocks. Please follow the instructions here to add "Copy" buttons to your code blocks.

-
Last updated on 2019-10-12 by Yangshun Tay
← CLI CommandsPages and Styles →