2020-05-18 18:19:40 +08:00
|
|
|
# Docs
|
2014-04-18 05:39:23 +08:00
|
|
|
|
2020-11-27 22:08:52 +08:00
|
|
|
This directory tree is used to build all the different docs for
|
2020-05-18 18:19:40 +08:00
|
|
|
rclone.
|
|
|
|
|
|
|
|
|
|
See the `content` directory for the docs in markdown format.
|
|
|
|
|
|
2021-11-04 19:50:43 +08:00
|
|
|
Note that some of the docs are auto-generated - these should have a DO
|
2020-05-18 18:19:40 +08:00
|
|
|
NOT EDIT marker near the top.
|
2014-04-18 05:39:23 +08:00
|
|
|
|
|
|
|
|
Use [hugo](https://github.com/spf13/hugo) to build the website.
|
2020-05-18 18:19:40 +08:00
|
|
|
|
|
|
|
|
## Changing the layout
|
|
|
|
|
|
|
|
|
|
If you want to change the layout then the main files to edit are
|
|
|
|
|
|
|
|
|
|
- `layout/index.html` for the front page
|
|
|
|
|
- `chrome/*.html` for the HTML fragments
|
|
|
|
|
- `_default/single.md` for the default template
|
|
|
|
|
- `page/single.md` for the page template
|
|
|
|
|
|
|
|
|
|
Running `make serve` in a terminal give a live preview of the website
|
|
|
|
|
so it is easy to tweak stuff.
|
|
|
|
|
|
|
|
|
|
## What are all these files
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
├── config.json - hugo config file
|
|
|
|
|
├── content - docs and backend docs
|
|
|
|
|
│ ├── _index.md - the front page of rclone.org
|
2021-11-04 19:50:43 +08:00
|
|
|
│ ├── commands - auto-generated command docs - DO NOT EDIT
|
2020-05-18 18:19:40 +08:00
|
|
|
├── i18n
|
|
|
|
|
│ └── en.toml - hugo multilingual config
|
|
|
|
|
├── layouts - how the markdown gets converted into HTML
|
|
|
|
|
│ ├── 404.html - 404 page
|
|
|
|
|
│ ├── chrome - contains parts of the HTML page included elsewhere
|
|
|
|
|
│ │ ├── footer.copyright.html - copyright footer
|
|
|
|
|
│ │ ├── footer.html - footer including scripts
|
|
|
|
|
│ │ ├── header.html - the whole html header
|
2020-10-14 05:49:58 +08:00
|
|
|
│ │ ├── header.includes.html - header includes e.g. css files
|
2020-05-18 18:19:40 +08:00
|
|
|
│ │ ├── menu.html - left hand side menu
|
|
|
|
|
│ │ ├── meta.html - meta tags for the header
|
|
|
|
|
│ │ └── navbar.html - top navigation bar
|
|
|
|
|
│ ├── _default
|
|
|
|
|
│ │ └── single.html - the default HTML page render
|
|
|
|
|
│ ├── index.html - the index page of the whole site
|
|
|
|
|
│ ├── page
|
|
|
|
|
│ │ └── single.html - the render of all "page" type markdown
|
2020-05-22 00:32:22 +08:00
|
|
|
│ ├── partials - bits of HTML to include into layout .html files
|
2020-05-18 18:19:40 +08:00
|
|
|
│ │ └── version.html - the current version number
|
|
|
|
|
│ ├── rss.xml - template for the RSS output
|
|
|
|
|
│ ├── section - rendering for sections
|
|
|
|
|
│ │ └── commands.html - rendering for /commands/index.html
|
2020-05-22 00:32:22 +08:00
|
|
|
│ ├── shortcodes - shortcodes to call from markdown files
|
2020-05-18 18:19:40 +08:00
|
|
|
│ │ ├── cdownload.html - download the "current" version
|
|
|
|
|
│ │ ├── download.html - download a version with the partials/version.html number
|
|
|
|
|
│ │ ├── provider.html - used to make provider list on the front page
|
|
|
|
|
│ │ └── version.html - used to insert the current version number
|
|
|
|
|
│ └── sitemap.xml - sitemap template
|
|
|
|
|
├── public - render of the website
|
|
|
|
|
├── README.md - this file
|
|
|
|
|
├── resources - don't know!
|
|
|
|
|
│ └── _gen
|
|
|
|
|
│ ├── assets
|
|
|
|
|
│ └── images
|
|
|
|
|
└── static - static content for the website
|
|
|
|
|
├── css
|
|
|
|
|
│ ├── bootstrap.css
|
|
|
|
|
│ ├── custom.css - custom css goes here
|
|
|
|
|
│ └── font-awesome.css
|
|
|
|
|
├── img - images used
|
|
|
|
|
├── js
|
|
|
|
|
│ ├── bootstrap.js
|
|
|
|
|
│ ├── custom.js - custom javascript goes here
|
|
|
|
|
│ └── jquery.js
|
|
|
|
|
└── webfonts
|
|
|
|
|
```
|
