Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
content/ | H | 01-Nov-2021 | - | 38,504 | 29,262 | |
i18n/ | H | 01-Nov-2021 | - | 6 | 4 | |
layouts/ | H | 03-May-2022 | - | 32 | 30 | |
static/ | H | 01-Nov-2021 | - | 203 | 180 | |
README.md | H A D | 01-Nov-2021 | 3.7 KiB | 78 | 67 | |
config.json | H A D | 01-Nov-2021 | 757 | 39 | 38 |
README.md
1# Docs 2 3This directory tree is used to build all the different docs for 4rclone. 5 6See the `content` directory for the docs in markdown format. 7 8Note that some of the docs are auto generated - these should have a DO 9NOT EDIT marker near the top. 10 11Use [hugo](https://github.com/spf13/hugo) to build the website. 12 13## Changing the layout 14 15If you want to change the layout then the main files to edit are 16 17- `layout/index.html` for the front page 18- `chrome/*.html` for the HTML fragments 19- `_default/single.md` for the default template 20- `page/single.md` for the page template 21 22Running `make serve` in a terminal give a live preview of the website 23so it is easy to tweak stuff. 24 25## What are all these files 26 27``` 28├── config.json - hugo config file 29├── content - docs and backend docs 30│ ├── _index.md - the front page of rclone.org 31│ ├── commands - auto generated command docs - DO NOT EDIT 32├── i18n 33│ └── en.toml - hugo multilingual config 34├── layouts - how the markdown gets converted into HTML 35│ ├── 404.html - 404 page 36│ ├── chrome - contains parts of the HTML page included elsewhere 37│ │ ├── footer.copyright.html - copyright footer 38│ │ ├── footer.html - footer including scripts 39│ │ ├── header.html - the whole html header 40│ │ ├── header.includes.html - header includes e.g. css files 41│ │ ├── menu.html - left hand side menu 42│ │ ├── meta.html - meta tags for the header 43│ │ └── navbar.html - top navigation bar 44│ ├── _default 45│ │ └── single.html - the default HTML page render 46│ ├── index.html - the index page of the whole site 47│ ├── page 48│ │ └── single.html - the render of all "page" type markdown 49│ ├── partials - bits of HTML to include into layout .html files 50│ │ └── version.html - the current version number 51│ ├── rss.xml - template for the RSS output 52│ ├── section - rendering for sections 53│ │ └── commands.html - rendering for /commands/index.html 54│ ├── shortcodes - shortcodes to call from markdown files 55│ │ ├── cdownload.html - download the "current" version 56│ │ ├── download.html - download a version with the partials/version.html number 57│ │ ├── provider.html - used to make provider list on the front page 58│ │ └── version.html - used to insert the current version number 59│ └── sitemap.xml - sitemap template 60├── public - render of the website 61├── README.md - this file 62├── resources - don't know! 63│ └── _gen 64│ ├── assets 65│ └── images 66└── static - static content for the website 67 ├── css 68 │ ├── bootstrap.css 69 │ ├── custom.css - custom css goes here 70 │ └── font-awesome.css 71 ├── img - images used 72 ├── js 73 │ ├── bootstrap.js 74 │ ├── custom.js - custom javascript goes here 75 │ └── jquery.js 76 └── webfonts 77``` 78