mirror of
https://github.com/rclone/rclone.git
synced 2026-02-26 09:23:20 +00:00
36913cda94
All PNG and JPEG images in the graphics/ and docs/static/img/ directories have been run through ImageOptim with lossless compression. This reduces the checkout size and the size of logo files served, without any change in visual quality. ```bash git diff --cached --stat docs/static/img/ncw-bitcoin-address.png | Bin 1100 -> 404 bytes docs/static/img/rclone-1200x630.png | Bin 36503 -> 24220 bytes docs/static/img/rclone-32x32.png | Bin 1106 -> 704 bytes graphics/cover.jpg | Bin 9986330 -> 8998666 bytes graphics/logo/favicon/favicon_16px.png | Bin 559 -> 389 bytes graphics/logo/favicon/favicon_32px.png | Bin 1106 -> 704 bytes graphics/logo/logo_on_dark/logo_on_dark__horizontal_color_128px.png | Bin 10651 -> 6655 bytes graphics/logo/logo_on_dark/logo_on_dark__horizontal_color_256px.png | Bin 22388 -> 14378 bytes graphics/logo/logo_on_dark/logo_on_dark__horizontal_color_32px.png | Bin 2656 -> 1650 bytes graphics/logo/logo_on_dark/logo_on_dark__horizontal_color_64px.png | Bin 5284 -> 3245 bytes graphics/logo/logo_on_dark/logo_on_dark__horizontal_mono_128px.png | Bin 9875 -> 5790 bytes graphics/logo/logo_on_dark/logo_on_dark__horizontal_mono_256px.png | Bin 21247 -> 10809 bytes graphics/logo/logo_on_dark/logo_on_dark__horizontal_mono_32px.png | Bin 2234 -> 1406 bytes graphics/logo/logo_on_dark/logo_on_dark__horizontal_mono_64px.png | Bin 4622 -> 2751 bytes graphics/logo/logo_on_dark/logo_on_dark__vertical_color_128px.png | Bin 3946 -> 2444 bytes graphics/logo/logo_on_dark/logo_on_dark__vertical_color_256px.png | Bin 8234 -> 5134 bytes graphics/logo/logo_on_dark/logo_on_dark__vertical_color_512px.png | Bin 17223 -> 10797 bytes graphics/logo/logo_on_dark/logo_on_dark__vertical_color_64px.png | Bin 1979 -> 1271 bytes graphics/logo/logo_on_dark/logo_on_dark__vertical_mono_128px.png | Bin 3490 -> 2104 bytes graphics/logo/logo_on_dark/logo_on_dark__vertical_mono_256px.png | Bin 7372 -> 4630 bytes graphics/logo/logo_on_dark/logo_on_dark__vertical_mono_512px.png | Bin 16451 -> 8358 bytes graphics/logo/logo_on_dark/logo_on_dark__vertical_mono_64px.png | Bin 1684 -> 1049 bytes graphics/logo/logo_on_dark/logo_symbol_on_dark_mono_128px.png | Bin 3889 -> 2239 bytes graphics/logo/logo_on_dark/logo_symbol_on_dark_mono_256px.png | Bin 8843 -> 4917 bytes graphics/logo/logo_on_dark/logo_symbol_on_dark_mono_512px.png | Bin 19071 -> 9074 bytes graphics/logo/logo_on_dark/logo_symbol_on_dark_mono_64px.png | Bin 1731 -> 1130 bytes graphics/logo/logo_on_light/logo_on_light__horizontal_color_128px.png | Bin 10621 -> 6860 bytes graphics/logo/logo_on_light/logo_on_light__horizontal_color_256px.png | Bin 22317 -> 14747 bytes graphics/logo/logo_on_light/logo_on_light__horizontal_color_32px.png | Bin 2594 -> 1655 bytes graphics/logo/logo_on_light/logo_on_light__horizontal_color_64px.png | Bin 5184 -> 3316 bytes graphics/logo/logo_on_light/logo_on_light__horizontal_mono_128px.png | Bin 8839 -> 5907 bytes graphics/logo/logo_on_light/logo_on_light__horizontal_mono_256px.png | Bin 19305 -> 11010 bytes graphics/logo/logo_on_light/logo_on_light__horizontal_mono_32px.png | Bin 2092 -> 1422 bytes graphics/logo/logo_on_light/logo_on_light__horizontal_mono_64px.png | Bin 4198 -> 2835 bytes graphics/logo/logo_on_light/logo_on_light__vertical_color_128px.png | Bin 3856 -> 2446 bytes graphics/logo/logo_on_light/logo_on_light__vertical_color_256px.png | Bin 8083 -> 5179 bytes graphics/logo/logo_on_light/logo_on_light__vertical_color_512px.png | Bin 16804 -> 11148 bytes graphics/logo/logo_on_light/logo_on_light__vertical_color_64px.png | Bin 1932 -> 1258 bytes graphics/logo/logo_on_light/logo_on_light__vertical_color_800px_2to1.png | Bin 23388 -> 12019 bytes graphics/logo/logo_on_light/logo_on_light__vertical_mono_128px.png | Bin 3139 -> 2106 bytes graphics/logo/logo_on_light/logo_on_light__vertical_mono_256px.png | Bin 6347 -> 4630 bytes graphics/logo/logo_on_light/logo_on_light__vertical_mono_512px.png | Bin 14138 -> 8358 bytes graphics/logo/logo_on_light/logo_on_light__vertical_mono_64px.png | Bin 1522 -> 1038 bytes graphics/logo/logo_on_light/logo_symbol_on_light_mono_128px.png | Bin 3193 -> 2241 bytes graphics/logo/logo_on_light/logo_symbol_on_light_mono_256px.png | Bin 6992 -> 4917 bytes graphics/logo/logo_on_light/logo_symbol_on_light_mono_512px.png | Bin 16638 -> 9074 bytes graphics/logo/logo_on_light/logo_symbol_on_light_mono_64px.png | Bin 1568 -> 1127 bytes graphics/logo/logo_symbol/logo_symbol_color_128px.png | Bin 4468 -> 2783 bytes graphics/logo/logo_symbol/logo_symbol_color_16px.png | Bin 1787 -> 391 bytes graphics/logo/logo_symbol/logo_symbol_color_256px.png | Bin 9362 -> 5835 bytes graphics/logo/logo_symbol/logo_symbol_color_512px.png | Bin 19898 -> 12946 bytes graphics/logo/logo_symbol/logo_symbol_color_600px_spaced.png | Bin 18775 -> 13537 bytes graphics/logo/logo_symbol/logo_symbol_color_64px.png | Bin 2235 -> 1380 bytes ```
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.htmlfor the front pagechrome/*.htmlfor the HTML fragments_default/single.mdfor the default templatepage/single.mdfor 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
├── fontawesome
│ ├── css
│ └── webfonts
├── img - images used
├── js
│ ├── bootstrap.js
│ ├── custom.js - custom javascript goes here
│ └── jquery.js