1 files deleted
1 files added
1 files renamed
4 files modified
| New file |
| | |
| | | +++ |
| | | title = "Customize layouts & components" |
| | | description = "basic configuration" |
| | | # weight = 10 |
| | | +++ |
| | | |
| | | ### Shortcodes modifiers |
| | | |
| | | These modifiers are classes you can use with shortcodes to customize the look and feel of your layouts and components. |
| | | |
| | | #### Grid |
| | | | modifier | space | |
| | | | --- | --- | |
| | | | grid-2 | 2 columns | |
| | | | grid-3 | 3 columns | |
| | | | grid-4 | 4 columns | |
| | | |
| | | #### Spacing |
| | | | modifier | space | |
| | | | ---| --- | |
| | | | mt-1 | 1.5rem top margin | |
| | | | mt-2 | 3rem top margin | |
| | | | mt-3 | 4.5rem top margin | |
| | | | mt-4 | 6rem top margin | |
| | | |
| | | > use pt-1 ~ pt-4 for top padding |
| | | |
| | | | modifier | space | |
| | | |---| --- | |
| | | | mb-1 | 1.5rem bottom margin | |
| | | | mb-2 | 3rem bottom margin | |
| | | | mb-3 | 4.5rem bottom margin | |
| | | | mb-4 | 6rem bottom margin | |
| | | |
| | | > use pb-1 ~ pb-4 for bottom padding |
| | | |
| | | ### How do I disable dark mode? |
| | | |
| | | Under `params` add `enableDarkMode = false` to your `config.toml` file. If your site is based on the exampleSite, the value is already included; you only need to uncomment it. |
| | | |
| | | > The user will still have the option to activate dark mode, if they so wish through the UI |
| | |
| | | +++ |
| | | title = "Bar Graphs, Charts & Tables" |
| | | title = "Graphs, charts & dynamic tables" |
| | | weight = 9 |
| | | [dataset1] |
| | | fileLink = "content/projects.csv" # path to where csv is stored |
| | |
| | | |
| | | Once you have a csv file, you display the charts as follows: |
| | | |
| | | ### Example |
| | | #### __Show a pie, doughnut & bar chart at once__ |
| | | #### Show a pie, doughnut & bar chart at once |
| | | |
| | | Firstly define the data you want to display from the front matter: |
| | | |
| | |
| | | {{< chart "dataset1" "table" >}} |
| | | {{< /block >}} |
| | | |
| | | ### Example 2 |
| | | |
| | | Firstly define the data you want to display from the front matter: |
| | | |
| | | ```toml |
| | |
| | | table = false # show table listing the chart data |
| | | ``` |
| | | |
| | | #### __Show only a pie and a doughnut chart__ |
| | | #### Show only a pie and a doughnut chart |
| | | |
| | | ```markdown |
| | | // from page content |
| File was renamed from exampleSite/content/docs/compose/getting-started.md |
| | |
| | | --- |
| | | title: "Getting Started" |
| | | title: "Install theme" |
| | | weight: 2 |
| | | description: > |
| | | This page tells you how to get started with the Compose theme, including installation and basic configuration. |
| | | This page tells you how to get started with the Compose theme. |
| | | --- |
| | | |
| | | ## Prerequisites and installation |
| | | ### Prerequisites |
| | | |
| | | ### Install Hugo |
| | | First ensure that you have hugo installed. |
| | | |
| | | You need a [recent **extended** version](https://github.com/gohugoio/hugo/releases) (we recommend version 0.61 or later) of [Hugo](https://gohugo.io/) to do local builds and previews of sites (like this one) that uses this theme. |
| | | |
| | |
| | | +++ |
| | | title = "Search" |
| | | title = "Search Function" |
| | | description = "" |
| | | weight = 8 |
| | | +++ |
| | |
| | | This is how the shortcodes would look like in action |
| | | --- |
| | | |
| | | ### Using blocks, columns & buttons |
| | | ### Blocks, columns & buttons |
| | | |
| | | ```sh |
| | | {{</* block "grid-2" */>}} |
| | |
| | | --- |
| | | title: "Shortcodes" |
| | | weight: 5 |
| | | description: > |
| | | Use hugo shortcodes to quickly compose site pages. |
| | | --- |
| | | +++ |
| | | title = "Shortcodes" |
| | | weight = 5 |
| | | description = "Use hugo shortcodes to quickly compose your documentation pages." |
| | | +++ |
| | | |
| | | Instead of writing all your site pages from scratch, Hugo lets you define and use [shortcodes](https://gohugo.io/content-management/shortcodes/). |
| | | |
| | | Why shortcodes? While markdown is sufficient to produce simple pages, it's insufficient where complex page structures are needed. Thusly, whenever we need special styling, shortcodes compliment the shortcomings of markdown. |
| | | |
| | | This way, you can side step complex html and css boilerplate in your content files. |
| | | This way, you can side step complex html and css boilerplate in your content files. |
| | | |
| | | Sometimes, the shortcode will wrap content, sometimes it won't. When content is wrapped, a closing shortcode tag is needed. Please see the link I provided above and the markdown files for examples. You'll get the gist pretty quickly. |
| | | |