History

albertony 5386ffc8f2 build: correct building for ARMv5 and ARMv6 Explicitly set ARM version in GOARM build variable, to avoid relying on some default value which differs when compiling natively and when cross-compiling, and which is also incorrectly documented as being 6 when in reality it is 5. Fix incorrect labelling of ARMv5 builds as ARMv6, and change architecture of .rpm and .deb packages containing them to match. Add ARMv6 builds, to complement existing ARMv5 and ARMv7, and to reduce disruption due to previous ARMv5 builds incorrectly being identified as ARMv6, and to provide .rpm and .deb packages with the same ARMv6 architectures as was previously also published (then containing ARMv5 binaries). See #6528 Background info: https://github.com/golang/go/wiki/GoArm https://go.dev/doc/install/source#environment `661e931dd1/src/cmd/dist/build.go (L140-L144)` `661e931dd1/src/cmd/dist/util.go (L392-L422)`		2023-02-04 13:32:26 +01:00
..
content	build: correct building for ARMv5 and ARMv6	2023-02-04 13:32:26 +01:00
i18n	website: Adapt to hugo v0.27.1	2017-09-30 09:19:53 +01:00
layouts	Start v1.62.0-DEV development	2022-12-20 18:33:59 +00:00
static	docs: better alignment of icons	2022-09-14 12:19:57 +01:00
config.json	docs: add table of contents to every page	2021-07-20 16:53:21 +01:00
README.md	docs: improve grammar and fix typos (#5361 )	2021-11-04 12:50:43 +01:00

README.md

Docs

This directory tree is used to build all the different docs for rclone.

See the content directory for the docs in markdown format.

Note that some of the docs are auto-generated - these should have a DO NOT EDIT marker near the top.

Use hugo to build the website.

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
│   ├── commands                  - auto-generated command docs - DO NOT EDIT
├── 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
│   │   ├── header.includes.html  - header includes e.g. css files
│   │   ├── 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
│   ├── partials                  - bits of HTML to include into layout .html files
│   │   └── version.html          - the current version number
│   ├── rss.xml                   - template for the RSS output
│   ├── section                   - rendering for sections
│   │   └── commands.html         - rendering for /commands/index.html
│   ├── shortcodes                - shortcodes to call from markdown files
│   │   ├── 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