From 6d2462e84a7b579e1a871fa5ca410fccedcaede5 Mon Sep 17 00:00:00 2001 From: Joel Marcey Date: Mon, 23 Apr 2018 15:31:10 -0700 Subject: [PATCH] Add docs for docs-based landing page Fixes #459 --- docs/getting-started-site-creation.md | 32 +++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/docs/getting-started-site-creation.md b/docs/getting-started-site-creation.md index 40cf149d8b..560a8fe029 100644 --- a/docs/getting-started-site-creation.md +++ b/docs/getting-started-site-creation.md @@ -61,3 +61,35 @@ To create a fully functional site, you only need to do a few steps: yarn run start # or `npm run start` # navigate to http://localhost:3000 ``` + +## Special Customization + +### Docs Landing Page + +If you prefer to have your landing page be straight to your documentation, you can do this through a redirect. + +1. Remove the `index.js` file from the `website/pages` directory, if it exists. +1. Add a [custom static `index.html` page](guides-custom-pages.md#adding-static-pages) in the `website/static` folder with the following contents: + +```html + + + + + + + Your Site Title Here + + + If you are not redirected automatically, follow this link. + + +``` + +> You will get the `id` of the document to land on the `.md` metadata of that doc page. + +### Blog Only + +You can also use Docusaurus to host your [blog only](guides-blog.md#i-want-to-run-in-blog-only-mode).