mirror of
https://github.com/gcushen/hugo-academic.git
synced 2025-07-26 19:15:16 +02:00
starters: add Docs starter
This commit is contained in:
parent
6224270ab3
commit
e576f7c3c3
27 changed files with 648 additions and 0 deletions
2
.github/workflows/split-packages.yaml
vendored
2
.github/workflows/split-packages.yaml
vendored
|
@ -21,6 +21,8 @@ jobs:
|
|||
split_repository: 'starter-hugo-markdown-slides'
|
||||
- local_path: 'blog'
|
||||
split_repository: 'hugo-blog-theme'
|
||||
- local_path: 'documentation'
|
||||
split_repository: 'hugo-documentation-theme'
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
|
20
starters/documentation/.editorconfig
Normal file
20
starters/documentation/.editorconfig
Normal file
|
@ -0,0 +1,20 @@
|
|||
# editorconfig.org
|
||||
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
end_of_line = lf
|
||||
indent_size = 2
|
||||
indent_style = space
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.toml]
|
||||
max_line_length = 100
|
||||
|
||||
[*.md]
|
||||
trim_trailing_whitespace = false
|
||||
|
||||
[layouts/shortcodes/*.html]
|
||||
insert_final_newline = false
|
7
starters/documentation/.gitignore
vendored
Normal file
7
starters/documentation/.gitignore
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
# IDEs
|
||||
.idea/
|
||||
|
||||
# Hugo
|
||||
resources/
|
||||
public/
|
||||
jsconfig.json
|
33
starters/documentation/README.md
Normal file
33
starters/documentation/README.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
# [Hugo Documentation Theme](https://github.com/wowchemy/hugo-documentation-theme)
|
||||
|
||||
[](https://wowchemy.com/hugo-themes/)
|
||||
|
||||
The **Documentation** starter template empowers you to easily create **product documentation**, **digital books**, **personal notes**, and **knowledge bases**.
|
||||
|
||||
[](https://wowchemy.com/hugo-themes/)
|
||||
[](https://discord.com/channels/722225264733716590/742892432458252370/742895548159492138)
|
||||
[](https://twitter.com/wowchemy)
|
||||
|
||||
[Check out the latest demo](https://book-starter.netlify.app/) of what you'll get in less than 10 minutes, or [get inspired by how others are using this template](https://wowchemy.com/creators/).
|
||||
|
||||
The integrated [**Wowchemy**](https://wowchemy.com) website builder and CMS makes it easy to create a beautiful website for free. Edit your site in the CMS (or your favorite editor), generate it with [Hugo](https://github.com/gohugoio/hugo), and deploy with GitHub or Netlify. Customize anything on your site with widgets, light/dark themes, and language packs.
|
||||
|
||||
- 👉 [**Get Started**](https://wowchemy.com/hugo-themes/)
|
||||
- 📚 [View the **documentation**](https://wowchemy.com/docs/)
|
||||
- 💬 [Chat with the **Wowchemy research community**](https://discord.gg/z8wNYzb) or [**Hugo community**](https://discourse.gohugo.io)
|
||||
- 🐦 Twitter: [@wowchemy](https://twitter.com/wowchemy) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithWowchemy](https://twitter.com/search?q=(%23MadeWithWowchemy%20OR%20%23MadeWithAcademic)&src=typed_query)
|
||||
- ⬇️ **Automatically import citations from BibTeX** with the [Hugo Academic CLI](https://github.com/wowchemy/hugo-academic-cli)
|
||||
- 💡 [Suggest an improvement](https://github.com/wowchemy/wowchemy-hugo-themes/issues)
|
||||
- ⬆️ **Updating?** View the [Update Guide](https://wowchemy.com/docs/hugo-tutorials/update/) and [Release Notes](https://github.com/wowchemy/wowchemy-hugo-themes/releases)
|
||||
|
||||
## We ask you, humbly, to support this open source movement
|
||||
|
||||
Today we ask you to defend the open source independence of the Wowchemy website builder and themes 🐧
|
||||
|
||||
We're an open source movement that depends on your support to stay online and thriving, but 99.9% of our creators don't give; they simply look the other way.
|
||||
|
||||
### [❤️ Click here to become a GitHub Sponsor, unlocking awesome perks such as _exclusive academic templates and widgets_](https://github.com/sponsors/gcushen)
|
||||
|
||||
<!--
|
||||
[![Screenshot]()](https://github.com/wowchemy/starter-book)
|
||||
-->
|
2
starters/documentation/assets/media/book.svg
Normal file
2
starters/documentation/assets/media/book.svg
Normal file
|
@ -0,0 +1,2 @@
|
|||
<?xml version="1.0"?>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" width="512" height="512"><g id="Outline"><g><path d="M61,16a1,1,0,0,0-1,1V53H54.57a85.082,85.082,0,0,0-19.12,2.178,1.992,1.992,0,0,1-2.1-.834A22.732,22.732,0,0,1,45.211,51H57a1,1,0,0,0,1-1V43a1,1,0,0,0-2,0v6H45.211A24.728,24.728,0,0,0,33,52.212V25a1,1,0,0,0-2,0V52.211A24.724,24.724,0,0,0,18.789,49H8V13H23.4A7.605,7.605,0,0,1,31,20.605a1,1,0,1,0,2,0A7.605,7.605,0,0,1,40.6,13H56V39a1,1,0,0,0,2,0V12a1,1,0,0,0-1-1H40.6A9.613,9.613,0,0,0,32,16.332,9.613,9.613,0,0,0,23.4,11H7a1,1,0,0,0-1,1V50a1,1,0,0,0,1,1H18.789a22.732,22.732,0,0,1,11.863,3.344,2,2,0,0,1-2.1.834A85.069,85.069,0,0,0,9.43,53H4V17a1,1,0,0,0-2,0V54a1,1,0,0,0,1,1H9.43A83.117,83.117,0,0,1,28.1,57.127,3.98,3.98,0,0,0,32,55.859a3.978,3.978,0,0,0,3.9,1.268A83.145,83.145,0,0,1,54.57,55H61a1,1,0,0,0,1-1V17A1,1,0,0,0,61,16Z"/><path d="M28.723,19.613A9.579,9.579,0,0,0,23.4,18H12a1,1,0,0,0,0,2H23.4a7.576,7.576,0,0,1,4.218,1.277,1,1,0,1,0,1.11-1.664Z"/><path d="M52,18H40.6a9.581,9.581,0,0,0-5.328,1.613,1,1,0,0,0,1.11,1.664A7.581,7.581,0,0,1,40.6,20H52a1,1,0,0,0,0-2Z"/><path d="M28.723,24.613A9.579,9.579,0,0,0,23.4,23H12a1,1,0,0,0,0,2H23.4a7.576,7.576,0,0,1,4.218,1.277,1,1,0,1,0,1.11-1.664Z"/><path d="M52,23H40.6a9.581,9.581,0,0,0-5.328,1.613,1,1,0,0,0,1.11,1.664A7.581,7.581,0,0,1,40.6,25H52a1,1,0,0,0,0-2Z"/><path d="M28.723,29.613A9.579,9.579,0,0,0,23.4,28H12a1,1,0,0,0,0,2H23.4a7.576,7.576,0,0,1,4.218,1.277,1,1,0,1,0,1.11-1.664Z"/><path d="M52,28H40.6a9.581,9.581,0,0,0-5.328,1.613,1,1,0,0,0,1.11,1.664A7.581,7.581,0,0,1,40.6,30H52a1,1,0,0,0,0-2Z"/><path d="M28.723,34.613A9.579,9.579,0,0,0,23.4,33H12a1,1,0,0,0,0,2H23.4a7.576,7.576,0,0,1,4.218,1.277,1,1,0,1,0,1.11-1.664Z"/><path d="M52,33H40.6a9.581,9.581,0,0,0-5.328,1.613,1,1,0,0,0,1.11,1.664A7.581,7.581,0,0,1,40.6,35H52a1,1,0,0,0,0-2Z"/><path d="M28.723,39.613A9.579,9.579,0,0,0,23.4,38H12a1,1,0,0,0,0,2H23.4a7.576,7.576,0,0,1,4.218,1.277,1,1,0,1,0,1.11-1.664Z"/><path d="M52,38H40.6a9.581,9.581,0,0,0-5.328,1.613,1,1,0,0,0,1.11,1.664A7.581,7.581,0,0,1,40.6,40H52a1,1,0,0,0,0-2Z"/><path d="M23.4,43H12a1,1,0,0,0,0,2H23.4a7.576,7.576,0,0,1,4.218,1.277,1,1,0,1,0,1.11-1.664A9.579,9.579,0,0,0,23.4,43Z"/><path d="M52,43H40.6a9.581,9.581,0,0,0-5.328,1.613,1,1,0,0,0,1.11,1.664A7.581,7.581,0,0,1,40.6,45H52a1,1,0,0,0,0-2Z"/></g></g></svg>
|
After Width: | Height: | Size: 2.3 KiB |
BIN
starters/documentation/assets/media/icon.png
Normal file
BIN
starters/documentation/assets/media/icon.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 12 KiB |
0
starters/documentation/assets/media/icons/.gitkeep
Normal file
0
starters/documentation/assets/media/icons/.gitkeep
Normal file
74
starters/documentation/config/_default/config.yaml
Normal file
74
starters/documentation/config/_default/config.yaml
Normal file
|
@ -0,0 +1,74 @@
|
|||
# Configuration of Hugo
|
||||
# Guide: https://wowchemy.com/docs/getting-started/
|
||||
# Hugo Documentation: https://gohugo.io/getting-started/configuration/#all-configuration-settings
|
||||
# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/
|
||||
|
||||
title: 'My Project' # Website name
|
||||
baseurl: '' # Website URL
|
||||
copyright: '' # Footer text, e.g. '© {year} Me'
|
||||
|
||||
############################
|
||||
## LANGUAGE
|
||||
############################
|
||||
|
||||
defaultContentLanguage: en
|
||||
hasCJKLanguage: false
|
||||
defaultContentLanguageInSubdir: false
|
||||
removePathAccents: true
|
||||
|
||||
############################
|
||||
## MODULES
|
||||
############################
|
||||
|
||||
module:
|
||||
imports:
|
||||
- path: github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms
|
||||
- path: github.com/wowchemy/wowchemy-hugo-modules/wowchemy
|
||||
|
||||
############################
|
||||
## ADVANCED
|
||||
############################
|
||||
|
||||
enableGitInfo: false
|
||||
summaryLength: 30
|
||||
paginate: 10
|
||||
enableEmoji: true
|
||||
enableRobotsTXT: true
|
||||
footnotereturnlinkcontents: <sup>^</sup>
|
||||
ignoreFiles: [\.ipynb$, .ipynb_checkpoints$, \.Rmd$, \.Rmarkdown$, _cache$]
|
||||
permalinks:
|
||||
authors: '/author/:slug/'
|
||||
tags: '/tag/:slug/'
|
||||
categories: '/category/:slug/'
|
||||
disableAliases: true
|
||||
outputs:
|
||||
home: [HTML, RSS, JSON, WebAppManifest, headers, redirects]
|
||||
section: [HTML, RSS]
|
||||
markup:
|
||||
defaultMarkdownHandler: goldmark
|
||||
goldmark:
|
||||
renderer:
|
||||
unsafe: true
|
||||
highlight:
|
||||
codeFences: false
|
||||
tableOfContents:
|
||||
startLevel: 2
|
||||
endLevel: 3
|
||||
imaging:
|
||||
resampleFilter: lanczos
|
||||
quality: 75
|
||||
anchor: smart
|
||||
timeout: 600000
|
||||
taxonomies:
|
||||
tag: tags
|
||||
category: categories
|
||||
author: authors
|
||||
related:
|
||||
threshold: 80
|
||||
includeNewer: true
|
||||
toLower: true
|
||||
indices:
|
||||
- name: tags
|
||||
weight: 100
|
||||
- name: categories
|
||||
weight: 70
|
22
starters/documentation/config/_default/languages.yaml
Normal file
22
starters/documentation/config/_default/languages.yaml
Normal file
|
@ -0,0 +1,22 @@
|
|||
# Languages
|
||||
# Create a section for each of your site's languages.
|
||||
# Documentation: https://wowchemy.com/docs/guide/language/
|
||||
|
||||
# Default language
|
||||
en:
|
||||
languageCode: en-us
|
||||
# Uncomment for multi-lingual sites, and move English content into `en` sub-folder.
|
||||
#contentDir: content/en
|
||||
|
||||
# Uncomment the lines below to configure your website in a second language.
|
||||
#zh:
|
||||
# languageCode: zh-Hans
|
||||
# contentDir: content/zh
|
||||
# title: Chinese website title...
|
||||
# params:
|
||||
# description: Site description in Chinese...
|
||||
# menu:
|
||||
# main:
|
||||
# - name: 传
|
||||
# url: '#about'
|
||||
# weight: 1
|
12
starters/documentation/config/_default/menus.yaml
Normal file
12
starters/documentation/config/_default/menus.yaml
Normal file
|
@ -0,0 +1,12 @@
|
|||
# Navigation Links
|
||||
# To link a homepage widget, specify the URL as a hash `#` followed by the filename of the
|
||||
# desired widget in your `content/home/` folder.
|
||||
# The weight parameter defines the order that the links will appear in.
|
||||
|
||||
main:
|
||||
- name: Home
|
||||
url: /
|
||||
weight: 10
|
||||
- name: Documentation
|
||||
url: docs/
|
||||
weight: 20
|
91
starters/documentation/config/_default/params.yaml
Normal file
91
starters/documentation/config/_default/params.yaml
Normal file
|
@ -0,0 +1,91 @@
|
|||
# SITE SETUP
|
||||
# Guide: https://wowchemy.com/docs/getting-started/
|
||||
# Documentation: https://wowchemy.com/docs/
|
||||
# This file is formatted using YAML syntax - learn more at https://learnxinyminutes.com/docs/yaml/
|
||||
|
||||
# Appearance
|
||||
|
||||
theme: minimal
|
||||
day_night: true
|
||||
font: ''
|
||||
font_size: L
|
||||
|
||||
# SEO
|
||||
|
||||
site_type: Project
|
||||
local_business_type: ''
|
||||
org_name: ''
|
||||
description: 'My project documentation.'
|
||||
twitter: ''
|
||||
|
||||
# Site header
|
||||
|
||||
main_menu:
|
||||
enable: true
|
||||
align: l
|
||||
show_logo: true
|
||||
show_language: false
|
||||
show_day_night: true
|
||||
show_search: true
|
||||
highlight_active_link: true
|
||||
|
||||
# Localization
|
||||
|
||||
date_format: 'Jan 2, 2006'
|
||||
time_format: '3:04 PM'
|
||||
|
||||
# Site features
|
||||
|
||||
highlight: false
|
||||
math: false
|
||||
diagram: false
|
||||
privacy_pack: false
|
||||
edit_page:
|
||||
repo_url: ''
|
||||
content_dir: ''
|
||||
repo_branch: main
|
||||
editable:
|
||||
book: false
|
||||
show_related:
|
||||
book: true
|
||||
sharing_image: ''
|
||||
reading_time: true
|
||||
section_pager: false
|
||||
docs_section_pager: true
|
||||
sharing: true
|
||||
copyright_license:
|
||||
enable: false
|
||||
allow_derivatives: false
|
||||
share_alike: true
|
||||
allow_commercial: false
|
||||
notice: 'This work is licensed under {license}'
|
||||
plugins_js: []
|
||||
breadcrumb:
|
||||
page_types:
|
||||
book: true
|
||||
comments:
|
||||
provider: ''
|
||||
commentable:
|
||||
book: true
|
||||
disqus:
|
||||
shortname: ''
|
||||
show_count: true
|
||||
commento:
|
||||
url: ''
|
||||
search:
|
||||
provider: wowchemy
|
||||
algolia:
|
||||
app_id: ''
|
||||
api_key: ''
|
||||
index_name: ''
|
||||
show_logo: false
|
||||
marketing:
|
||||
google_analytics: ''
|
||||
google_tag_manager: ''
|
||||
google_site_verification: ''
|
||||
cms:
|
||||
branch: main
|
||||
local_backend: false
|
||||
icon:
|
||||
pack:
|
||||
ai: false
|
9
starters/documentation/content/docs/_index.md
Normal file
9
starters/documentation/content/docs/_index.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
title: Docs
|
||||
type: book # Do not modify.
|
||||
toc: false
|
||||
---
|
||||
|
||||
Welcome to the _Project Docs_ template!
|
||||
|
||||
{{< cta cta_text="👉 Get Started with Chapter 1" cta_link="chapter1" >}}
|
56
starters/documentation/content/docs/chapter1/_index.md
Normal file
56
starters/documentation/content/docs/chapter1/_index.md
Normal file
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
# Title, summary, and page position.
|
||||
linktitle: Chapter 1
|
||||
summary: Learn how to use Wowchemy's docs layout for publishing online courses, software documentation, and tutorials.
|
||||
weight: 1
|
||||
icon: book
|
||||
icon_pack: fas
|
||||
|
||||
# Page metadata.
|
||||
title: Chapter 1
|
||||
date: "2018-09-09T00:00:00Z"
|
||||
type: book # Do not modify.
|
||||
---
|
||||
|
||||
## Flexibility
|
||||
|
||||
Document everything!
|
||||
|
||||
This feature can be used for publishing content such as:
|
||||
|
||||
* **Online courses**
|
||||
* **Project or software documentation**
|
||||
* **Tutorials**
|
||||
* **Notes**
|
||||
|
||||
The `courses` folder may be renamed. For example, we can rename it to `docs` for software/project documentation or `tutorials` for creating an online course.
|
||||
|
||||
## Delete courses
|
||||
|
||||
**To remove these pages, delete the `courses` folder and see below to delete the associated menu link.**
|
||||
|
||||
## Update site menu
|
||||
|
||||
After renaming or deleting the `courses` folder, you may wish to update any `[[main]]` menu links to it by editing your menu configuration at `config/_default/menus.toml`.
|
||||
|
||||
For example, if you delete this folder, you can remove the following from your menu configuration:
|
||||
|
||||
```toml
|
||||
[[main]]
|
||||
name = "Courses"
|
||||
url = "courses/"
|
||||
weight = 50
|
||||
```
|
||||
|
||||
Or, if you are creating a software documentation site, you can rename the `courses` folder to `docs` and update the associated *Courses* menu configuration to:
|
||||
|
||||
```toml
|
||||
[[main]]
|
||||
name = "Docs"
|
||||
url = "docs/"
|
||||
weight = 50
|
||||
```
|
||||
|
||||
## Update the docs menu
|
||||
|
||||
If you use the *docs* layout, note that the name of the menu in the front matter should be in the form `[menu.X]` where `X` is the folder name. Hence, if you rename the `courses/example/` folder, you should also rename the menu definitions in the front matter of files within `courses/example/` from `[menu.example]` to `[menu.<NewFolderName>]`.
|
35
starters/documentation/content/docs/chapter1/reading-list.md
Normal file
35
starters/documentation/content/docs/chapter1/reading-list.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: Reading List
|
||||
linktitle: Reading List
|
||||
type: book
|
||||
date: "2019-05-05T00:00:00+01:00"
|
||||
# Prev/next pager order (if `docs_section_pager` enabled in `params.toml`)
|
||||
weight: 2
|
||||
---
|
||||
|
||||
A recommended reading list for the course.
|
||||
|
||||
## Books
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
||||
|
||||
|
||||
## Videos
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
34
starters/documentation/content/docs/chapter1/syllabus.md
Normal file
34
starters/documentation/content/docs/chapter1/syllabus.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: Syllabus
|
||||
linktitle: Syllabus
|
||||
type: book
|
||||
date: "2019-05-05T00:00:00+01:00"
|
||||
|
||||
# Prev/next pager order (if `docs_section_pager` enabled in `params.toml`)
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Goals
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
||||
|
||||
|
||||
## Topics
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
19
starters/documentation/content/docs/chapter1/takeaways.md
Normal file
19
starters/documentation/content/docs/chapter1/takeaways.md
Normal file
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
title: Takeaways
|
||||
linktitle: Takeaways
|
||||
type: book
|
||||
date: "2019-05-05T00:00:00+01:00"
|
||||
|
||||
# Prev/next pager order (if `docs_section_pager` enabled in `params.toml`)
|
||||
weight: 3
|
||||
---
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
54
starters/documentation/content/docs/chapter2/_index.md
Normal file
54
starters/documentation/content/docs/chapter2/_index.md
Normal file
|
@ -0,0 +1,54 @@
|
|||
---
|
||||
# Title, summary, and page position.
|
||||
linktitle: Chapter 2
|
||||
summary: Learn how to use Academic's docs layout for publishing online courses, software documentation, and tutorials.
|
||||
weight: 1
|
||||
icon: book-reader
|
||||
icon_pack: fas
|
||||
|
||||
# Page metadata.
|
||||
title: Chapter 2
|
||||
date: "2018-09-09T00:00:00Z"
|
||||
type: book # Do not modify.
|
||||
---
|
||||
|
||||
## Flexibility
|
||||
|
||||
This feature can be used for publishing content such as:
|
||||
|
||||
* **Online courses**
|
||||
* **Project or software documentation**
|
||||
* **Tutorials**
|
||||
* **Notes**
|
||||
|
||||
The `courses` folder may be renamed. For example, we can rename it to `docs` for software/project documentation or `tutorials` for creating an online course.
|
||||
|
||||
## Delete courses
|
||||
|
||||
**To remove these pages, delete the `courses` folder and see below to delete the associated menu link.**
|
||||
|
||||
## Update site menu
|
||||
|
||||
After renaming or deleting the `courses` folder, you may wish to update any `[[main]]` menu links to it by editing your menu configuration at `config/_default/menus.toml`.
|
||||
|
||||
For example, if you delete this folder, you can remove the following from your menu configuration:
|
||||
|
||||
```toml
|
||||
[[main]]
|
||||
name = "Courses"
|
||||
url = "courses/"
|
||||
weight = 50
|
||||
```
|
||||
|
||||
Or, if you are creating a software documentation site, you can rename the `courses` folder to `docs` and update the associated *Courses* menu configuration to:
|
||||
|
||||
```toml
|
||||
[[main]]
|
||||
name = "Docs"
|
||||
url = "docs/"
|
||||
weight = 50
|
||||
```
|
||||
|
||||
## Update the docs menu
|
||||
|
||||
If you use the *docs* layout, note that the name of the menu in the front matter should be in the form `[menu.X]` where `X` is the folder name. Hence, if you rename the `courses/example/` folder, you should also rename the menu definitions in the front matter of files within `courses/example/` from `[menu.example]` to `[menu.<NewFolderName>]`.
|
35
starters/documentation/content/docs/chapter2/reading-list.md
Normal file
35
starters/documentation/content/docs/chapter2/reading-list.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: Reading List
|
||||
linktitle: Reading List
|
||||
type: book
|
||||
date: "2019-05-05T00:00:00+01:00"
|
||||
# Prev/next pager order (if `docs_section_pager` enabled in `params.toml`)
|
||||
weight: 2
|
||||
---
|
||||
|
||||
A recommended reading list for the course.
|
||||
|
||||
## Books
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
||||
|
||||
|
||||
## Videos
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
34
starters/documentation/content/docs/chapter2/syllabus.md
Normal file
34
starters/documentation/content/docs/chapter2/syllabus.md
Normal file
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: Syllabus
|
||||
linktitle: Syllabus
|
||||
type: book
|
||||
date: "2019-05-05T00:00:00+01:00"
|
||||
|
||||
# Prev/next pager order (if `docs_section_pager` enabled in `params.toml`)
|
||||
weight: 1
|
||||
---
|
||||
|
||||
## Goals
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
||||
|
||||
|
||||
## Topics
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
22
starters/documentation/content/docs/chapter2/takeaways.md
Normal file
22
starters/documentation/content/docs/chapter2/takeaways.md
Normal file
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: Takeaways
|
||||
linktitle: Takeaways
|
||||
toc: true
|
||||
type: book
|
||||
date: "2019-05-05T00:00:00+01:00"
|
||||
draft: true
|
||||
|
||||
|
||||
# Prev/next pager order (if `docs_section_pager` enabled in `params.toml`)
|
||||
weight: 3
|
||||
---
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis posuere tellus ac convallis placerat. Proin tincidunt magna sed ex sollicitudin condimentum. Sed ac faucibus dolor, scelerisque sollicitudin nisi. Cras purus urna, suscipit quis sapien eu, pulvinar tempor diam. Quisque risus orci, mollis id ante sit amet, gravida egestas nisl. Sed ac tempus magna. Proin in dui enim. Donec condimentum, sem id dapibus fringilla, tellus enim condimentum arcu, nec volutpat est felis vel metus. Vestibulum sit amet erat at nulla eleifend gravida.
|
||||
|
||||
Nullam vel molestie justo. Curabitur vitae efficitur leo. In hac habitasse platea dictumst. Sed pulvinar mauris dui, eget varius purus congue ac. Nulla euismod, lorem vel elementum dapibus, nunc justo porta mi, sed tempus est est vel tellus. Nam et enim eleifend, laoreet sem sit amet, elementum sem. Morbi ut leo congue, maximus velit ut, finibus arcu. In et libero cursus, rutrum risus non, molestie leo. Nullam congue quam et volutpat malesuada. Sed risus tortor, pulvinar et dictum nec, sodales non mi. Phasellus lacinia commodo laoreet. Nam mollis, erat in feugiat consectetur, purus eros egestas tellus, in auctor urna odio at nibh. Mauris imperdiet nisi ac magna convallis, at rhoncus ligula cursus.
|
||||
|
||||
Cras aliquam rhoncus ipsum, in hendrerit nunc mattis vitae. Duis vitae efficitur metus, ac tempus leo. Cras nec fringilla lacus. Quisque sit amet risus at ipsum pharetra commodo. Sed aliquam mauris at consequat eleifend. Praesent porta, augue sed viverra bibendum, neque ante euismod ante, in vehicula justo lorem ac eros. Suspendisse augue libero, venenatis eget tincidunt ut, malesuada at lorem. Donec vitae bibendum arcu. Aenean maximus nulla non pretium iaculis. Quisque imperdiet, nulla in pulvinar aliquet, velit quam ultrices quam, sit amet fringilla leo sem vel nunc. Mauris in lacinia lacus.
|
||||
|
||||
Suspendisse a tincidunt lacus. Curabitur at urna sagittis, dictum ante sit amet, euismod magna. Sed rutrum massa id tortor commodo, vitae elementum turpis tempus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean purus turpis, venenatis a ullamcorper nec, tincidunt et massa. Integer posuere quam rutrum arcu vehicula imperdiet. Mauris ullamcorper quam vitae purus congue, quis euismod magna eleifend. Vestibulum semper vel augue eget tincidunt. Fusce eget justo sodales, dapibus odio eu, ultrices lorem. Duis condimentum lorem id eros commodo, in facilisis mauris scelerisque. Morbi sed auctor leo. Nullam volutpat a lacus quis pharetra. Nulla congue rutrum magna a ornare.
|
||||
|
||||
Aliquam in turpis accumsan, malesuada nibh ut, hendrerit justo. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Quisque sed erat nec justo posuere suscipit. Donec ut efficitur arcu, in malesuada neque. Nunc dignissim nisl massa, id vulputate nunc pretium nec. Quisque eget urna in risus suscipit ultricies. Pellentesque odio odio, tincidunt in eleifend sed, posuere a diam. Nam gravida nisl convallis semper elementum. Morbi vitae felis faucibus, vulputate orci placerat, aliquet nisi. Aliquam erat volutpat. Maecenas sagittis pulvinar purus, sed porta quam laoreet at.
|
20
starters/documentation/content/home/features.md
Normal file
20
starters/documentation/content/home/features.md
Normal file
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
widget: featurette
|
||||
headless: true
|
||||
weight: 20
|
||||
title: Features
|
||||
subtitle: Document _anything_ ✨
|
||||
feature:
|
||||
- icon: book-open
|
||||
icon_pack: fas
|
||||
name: Project Documentation
|
||||
description: For users
|
||||
- icon: question
|
||||
icon_pack: fas
|
||||
name: Knowledge Base
|
||||
description: For teams
|
||||
- icon: list-alt
|
||||
icon_pack: fas
|
||||
name: Personal Notebook
|
||||
description: For yourself
|
||||
---
|
31
starters/documentation/content/home/hero.md
Normal file
31
starters/documentation/content/home/hero.md
Normal file
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
widget: hero
|
||||
headless: true
|
||||
weight: 10
|
||||
title: Project Docs Template
|
||||
hero_media: book.svg
|
||||
design:
|
||||
background:
|
||||
gradient_start: '#4bb4e3'
|
||||
gradient_end: '#2b94c3'
|
||||
text_color_light: true
|
||||
cta:
|
||||
url: docs/
|
||||
label: Get Started
|
||||
icon_pack: fas
|
||||
icon: download
|
||||
cta_alt:
|
||||
url: docs/
|
||||
label: View Documentation
|
||||
cta_note:
|
||||
label: >-
|
||||
<span class="js-github-release" data-repo="wowchemy/wowchemy-hugo-modules">
|
||||
Show your product version here:<!-- Automatically filled based on data-repo value -->
|
||||
</span>
|
||||
---
|
||||
|
||||
Published with the [Wowchemy Website Builder](https://wowchemy.com/) for Hugo.
|
||||
|
||||
Write something interesting about your project here.
|
||||
|
||||
<a class="github-button" href="https://github.com/wowchemy/wowchemy-hugo-modules" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star Wowchemy Website Builder for Hugo">Star Wowchemy Website Builder for Hugo</a><br><a class="github-button" href="https://github.com/wowchemy/starter-hugo-project-documentation" data-icon="octicon-star" data-size="large" data-show-count="true" aria-label="Star the Project Docs template">Star the Project Docs template</a><script async defer src="https://buttons.github.io/buttons.js"></script>
|
7
starters/documentation/content/home/index.md
Normal file
7
starters/documentation/content/home/index.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
# Homepage
|
||||
type: "widget_page"
|
||||
|
||||
# Homepage is headless, other widget pages are not.
|
||||
headless: true
|
||||
---
|
8
starters/documentation/go.mod
Normal file
8
starters/documentation/go.mod
Normal file
|
@ -0,0 +1,8 @@
|
|||
module github.com/wowchemy/starter-book
|
||||
|
||||
go 1.14
|
||||
|
||||
require (
|
||||
github.com/wowchemy/wowchemy-hugo-modules/wowchemy v0.0.0-20210526223849-81ba17522966 // indirect
|
||||
github.com/wowchemy/wowchemy-hugo-modules/wowchemy-cms v0.0.0-20210526223849-81ba17522966 // indirect
|
||||
)
|
21
starters/documentation/netlify.toml
Normal file
21
starters/documentation/netlify.toml
Normal file
|
@ -0,0 +1,21 @@
|
|||
[build]
|
||||
command = "hugo --gc --minify -b $URL"
|
||||
publish = "public"
|
||||
|
||||
[build.environment]
|
||||
HUGO_VERSION = "0.83.1"
|
||||
HUGO_ENABLEGITINFO = "true"
|
||||
|
||||
[context.production.environment]
|
||||
HUGO_ENV = "production"
|
||||
|
||||
[context.deploy-preview]
|
||||
command = "hugo --gc --minify --buildFuture -b $DEPLOY_PRIME_URL"
|
||||
|
||||
[context.branch-deploy]
|
||||
command = "hugo --gc --minify -b $DEPLOY_PRIME_URL"
|
||||
|
||||
[[plugins]]
|
||||
package = "netlify-plugin-hugo-cache-resources"
|
||||
[plugins.inputs]
|
||||
debug = true
|
BIN
starters/documentation/preview.png
Normal file
BIN
starters/documentation/preview.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 54 KiB |
0
starters/documentation/static/uploads/.gitkeep
Normal file
0
starters/documentation/static/uploads/.gitkeep
Normal file
Loading…
Add table
Add a link
Reference in a new issue