15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-31 06:32:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add docs for docs-based landing page 

Fixes #459
This commit is contained in:
Joel Marcey 2018-04-23 15:31:10 -07:00
parent 4e575e9234
commit 6d2462e84a
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/getting-started-site-creation.md
View File

@ -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
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="0; url=docs/id-of-doc-to-land-on.html">
<script type="text/javascript">
window.location.href = "docs/id-of-doc-to-land-on.html"
</script>
<title>Your Site Title Here</title>
</head>
<body>
If you are not redirected automatically, follow this <a href='docs/id-of-doc-to-land-on.html'>link</a>.
</body>
</html>
```
> 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).