mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2024-09-20 11:58:47 -04:00
5d9d7786a2
Closes #7 , closes #9 The existing outdated Hugo documentation in this repo will be replaced with the following more-or-less *evergreen* content: - **Markdown & HTML Syntax Guide** shows whether a theme has decorated basic HTML elements with CSS. Note that I have not included the Markdown syntax for aligning table columns due to: https://github.com/russross/blackfriday/issues/506 - **Rich Content** features a brief showcase of Hugo’s Privacy config and related Simple shortcodes. Note that I have chosen to embed content that showcases typography by several designers in various media including a 360° interactive YouTube video (for inspiration). Also these embeds should be covered under [Fair Use](https://fairuse.stanford.edu/overview/fair-use/what-is-fair-use/) since these are meant for teaching users how these Hugo shortcodes work. - **Placeholder Content** includes dummy copy along with a diagram and a link with info about the *Van de Graaf Canon* for constructing layouts (that can also be applied to websites). Note: the diagram is Open Source and taken from https://en.wikipedia.org/wiki/Canons_of_page_construction#Van_de_Graaf_canon (there is a link to this page in the caption). - **Math Typesetting** a brief tutorial about enabling KaTeX in Hugo (the Hugo Docs mention MathJax which is slower) - **Emoji Support** brief tutorial about Hugo’s built-in Unicode emoji support (as mentioned in the Hugo Docs) but also this includes an original technique for enabling non Unicode emoji in Hugo by using Static Image Replacement with the `replaceRE` function. Note: custom icons are from the Open Source [Mutant Standard](https://mutant.tech) emoji set. Also note that the **About** Page has been expanded and updated to reflect Hugo’s current features. --- **NOTES** Besides quoting from the Hugo Docs (when needed), these content files contain original content written and curated by me and whatever sources I used were modified to such an extent that there is no need for footnotes. The author credit for the new content is Hugo Authors since this is meant for the Hugo community -of which I am a current member- furthermore the content also may be modified by someone else in the future, so this credit seems more appropriate than one with my name. P.S. @digitalcraftsman I have not included a guide about Modular Typography as this would have been quite involved and I am running out of time. P.S.2 This PR also fixes the path of the `menu.main` `/about/` item see: #41 by @guylyons
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
+++
|
||
title = "About"
|
||
description = "Hugo, the world’s fastest framework for building websites"
|
||
date = "2019-02-28"
|
||
aliases = ["about-us","about-hugo","contact"]
|
||
author = "Hugo Authors"
|
||
+++
|
||
|
||
Written in Go, Hugo is an open source static site generator available under the [Apache Licence 2.0.](https://github.com/gohugoio/hugo/blob/master/LICENSE) Hugo supports TOML, YAML and JSON data file types, Markdown and HTML content files and uses shortcodes to add rich content. Other notable features are taxonomies, multilingual mode, image processing, custom output formats, HTML/CSS/JS minification and support for Sass SCSS workflows.
|
||
|
||
Hugo makes use of a variety of open source projects including:
|
||
|
||
* https://github.com/russross/blackfriday
|
||
* https://github.com/alecthomas/chroma
|
||
* https://github.com/muesli/smartcrop
|
||
* https://github.com/spf13/cobra
|
||
* https://github.com/spf13/viper
|
||
|
||
Hugo is ideal for blogs, corporate websites, creative portfolios, online magazines, single page applications or even a website with thousands of pages.
|
||
|
||
Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases.
|
||
|
||
Websites built with Hugo are extremelly fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider.
|
||
|
||
Learn more and contribute on [GitHub](https://github.com/gohugoio).
|
||
|
||
|
||
|