Skip to content

Commit

Permalink
feat: initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
gcushen committed Aug 6, 2020
1 parent 355a055 commit 4644503
Show file tree
Hide file tree
Showing 32 changed files with 858 additions and 3 deletions.
20 changes: 20 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# IDEs
.idea/

# Hugo
resources/
public/
2 changes: 1 addition & 1 deletion LICENSE → LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Source Themes
Copyright (c) 2020-present George Cushen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,26 @@
# academic-starter-docs
Project Docs template for Academic Website Builder
<p align="center"><a href="https://sourcethemes.com/academic/" target="_blank" rel="noopener"><img src="https://sourcethemes.com/academic/img/logo_200px.png" alt="Academic logo"></a></p>

# Book Template for [Academic Website Builder](https://sourcethemes.com/academic/)

The **Book Template** empowers you to create **product documentation**, **digital books**, **personal notes**, and **knowledge bases**.

[**Academic**](https://github.com/gcushen/hugo-academic) makes it easy to create a beautiful website for free using Markdown, Jupyter, or RStudio. Customize anything on your site with widgets, themes, and language packs. [Check out the latest demo](https://academic-demo.netlify.app/) of what you'll get in less than 10 minutes, or [view the showcase](https://sourcethemes.com/academic/#expo).

- 👉 [**Get Started**](https://sourcethemes.com/academic/docs/install)
- 📚 [View the **documentation**](https://sourcethemes.com/academic/docs/)
- 💬 [Chat with the **Academic community**](https://spectrum.chat/academic) or [**Hugo community**](https://discourse.gohugo.io)
- 🐦 Twitter: [@source_themes](https://twitter.com/source_themes) [@GeorgeCushen](https://twitter.com/GeorgeCushen) [#MadeWithAcademic](https://twitter.com/search?q=%23MadeWithAcademic&src=typd)
- 💡 [Request a **feature** or report a **bug** for _Academic_](https://github.com/gcushen/hugo-academic/issues)
- ⬆️ **Updating Academic?** View the [Update Guide](https://sourcethemes.com/academic/docs/update/) and [Release Notes](https://sourcethemes.com/academic/updates/)

## Crowd-funded open-source software

To help us develop this template and software sustainably under the MIT license, we ask all individuals and businesses that use it to help support its ongoing maintenance and development via sponsorship.

### [❤️ Click here to unlock rewards with sponsorship](https://sourcethemes.com/academic/plans/)

<!--
[![Screenshot]()](https://github.com/sourcethemes/academic-starter-book)
-->

[![Analytics](https://ga-beacon.appspot.com/UA-78646709-2/academic-kickstart/readme?pixel)](https://github.com/igrigorik/ga-beacon)
Empty file added assets/images/.gitkeep
Empty file.
Empty file.
Binary file added assets/images/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
109 changes: 109 additions & 0 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
# Configuration of Hugo
# Guide: https://sourcethemes.com/academic/docs/get-started/
# Hugo Documentation: https://gohugo.io/getting-started/configuration/#all-configuration-settings
#
# This file is formatted using TOML syntax - learn more at https://learnxinyminutes.com/docs/toml/
# Each configuration section is defined by a name in square brackets (e.g. `[outputs]`).

# Title of your site
title = "My Book | Made with Academic"

# The URL of your site.
# End your URL with a `/` trailing slash, e.g. `https://example.com/`.
baseurl = "/"

# Enter a copyright notice to display in the site footer.
# To display a copyright symbol, type `&copy;`. For current year, type `{year}`.
copyright = ""

############################
## Advanced options below ##
############################

# Get last modified date for content from Git?
enableGitInfo = false

# Default language to use (if you setup multilingual support)
defaultContentLanguage = "en"
hasCJKLanguage = false # Set `true` for Chinese/Japanese/Korean languages.
defaultContentLanguageInSubdir = false
removePathAccents = true # Workaround for https://github.com/gohugoio/hugo/issues/5687

summaryLength = 30 # Listing summary length in words. Also, see `abstract_length` in `params.toml`.
paginate = 10 # Number of items per page in paginated lists.
enableEmoji = true
footnotereturnlinkcontents = "<sup>^</sup>"
ignoreFiles = ["\\.ipynb$", ".ipynb_checkpoints$", "\\.Rmd$", "\\.Rmarkdown$", "_files$", "_cache$"]

# Install Academic
[module]
[[module.imports]]
path = "github.com/gcushen/hugo-academic"

# Workaround Hugo publishing taxonomy URLs as plurals - consistently use singular across Academic.
[permalinks]
authors = "/author/:slug/"
tags = "/tag/:slug/"
categories = "/category/:slug/"
publication_types = "/publication-type/:slug/"

[outputs]
home = [ "HTML", "RSS", "JSON", "WebAppManifest" ]
section = [ "HTML", "RSS" ]

[mediaTypes."application/manifest+json"]
suffixes = ["webmanifest"]

[outputFormats.WebAppManifest]
mediaType = "application/manifest+json"
rel = "manifest"

# Configure the Markdown renderer.
[markup]
defaultMarkdownHandler = "goldmark"
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true # Enable user to embed HTML snippets in Markdown content.
[markup.highlight]
codeFences = false # Disable Hugo's code highlighter as it conflicts with Academic's highligher.
[markup.tableOfContents]
startLevel = 2
endLevel = 3

[imaging]
resampleFilter = "lanczos"
quality = 75
anchor = "smart" # Anchor for cropping. Options include Smart and Center.

# Taxonomies.
[taxonomies]
tag = "tags"
category = "categories"
publication_type = "publication_types"
author = "authors"

# Related content.
[related]
threshold = 80.0
includeNewer = true
toLower = true

[[related.indices]]
name = "title"
weight = 60.0

[[related.indices]]
name = "summary"
weight = 50.0

[[related.indices]]
name = "tags"
weight = 80.0

[[related.indices]]
name = "categories"
weight = 70.0

[[related.indices]]
name = "authors"
weight = 20.0
20 changes: 20 additions & 0 deletions config/_default/languages.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Languages
# Create a `[X]` block for each language you want, where X is the language ID.
# Refer to https://sourcethemes.com/academic/docs/language/

# Configure the English version of the site.
[en]
languageCode = "en-us"
# contentDir = "content/en" # Uncomment for multi-lingual sites, and move English content into `en` sub-folder.

# Uncomment the lines below to configure your website in a second language.
#[zh]
# languageCode = "zh-Hans"
# contentDir = "content/zh"
# title = "Chinese website title..."
# [zh.params]
# description = "Site description in Chinese..."
# [[zh.menu.main]]
# name = "Wo"
# url = "#about"
# weight = 1
9 changes: 9 additions & 0 deletions config/_default/menus.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 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 = "Docs"
url = "docs/"
weight = 10
Loading

0 comments on commit 4644503

Please sign in to comment.