diff options
| author | 2023-04-19 17:30:39 +0800 | |
|---|---|---|
| committer | 2023-04-19 17:30:39 +0800 | |
| commit | 3adc965dd09490b7efa1cce9f09b0a3b30970277 (patch) | |
| tree | f813abb07d7b003984aa74e3154752b6ffc3ccd5 /docs/.docs/content/2.api/3.layouts.md | |
| parent | c7c9ca6f0c8eddf6d34cd40779f3b2d9463f3a46 (diff) | |
| download | HydroRoll-3adc965dd09490b7efa1cce9f09b0a3b30970277.tar.gz HydroRoll-3adc965dd09490b7efa1cce9f09b0a3b30970277.zip | |
✨优化文档
Diffstat (limited to 'docs/.docs/content/2.api/3.layouts.md')
| -rw-r--r-- | docs/.docs/content/2.api/3.layouts.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/.docs/content/2.api/3.layouts.md b/docs/.docs/content/2.api/3.layouts.md new file mode 100644 index 0000000..25dc458 --- /dev/null +++ b/docs/.docs/content/2.api/3.layouts.md @@ -0,0 +1,43 @@ +# Layouts +Docus provides multiple built-in layouts for displaying your Markdown pages. + +## `default` + +The default layout for every page created in the project. This layout renders multiple section alongside the content: + +- Aside navigation menu (togglable with `aside: false/true`) +- Page bottom section (togglable with `bottom: false/true`) +- Table of content (togglable with `toc: false/true`) + +```md [index.md] +--- +aside: true +bottom: true +toc: false +--- + +Your awesome content +``` + +Current page is live sample of default layout. + +## `page` + +`page` layout is content focused layout. This layout does not render aside menu of table of contents. + + +This layout accept some configuration from content front-matter. + +- `fluid`: By setting `fluid: true` in content front-matter the content will be rendered in full width. +- `constrainedClass`: Using this option you can modify layout container look. Like constraining layout width of changing the background. +- `padded`: Setting `padded: true` in front-matter will add horizontal padding in the layout. + +```md [index.md] +--- +title: Home +layout: page +fluid: true +--- +``` + +Check [Home page](/) as live sample of page layout |
