diff options
| -rw-r--r-- | CHANGELOG.md | 4 | ||||
| -rw-r--r-- | README.md | 63 | ||||
| -rw-r--r-- | exampleSite/content/about.md | 2 |
3 files changed, 17 insertions, 52 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 19120c3..f0c636d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased](https://github.com/sergeyklay/gohugo-theme-ed/compare/v0.1.0...HEAD) +### Changed + +- Amend documentation + ## v0.1.0 - 2022-05-27 - Initial release @@ -1,8 +1,8 @@ -# Ed +<h1 align=center>Ed | <a href="https://gohugo-theme-ed.netlify.app/" rel="nofollow">Demo</a></h1> -Ed is a [Hugo][hugo] theme designed for textual editors based on -[minimal computing][mincomp] principles, and focused on legibility, durability, -ease and flexibility. +Ed is a [Hugo](http://gohugo.io) theme designed for textual editors based on +[minimal computing](http://go-dh.github.io/mincomp/) principles, and focused +on legibility, durability, ease and flexibility. --- @@ -13,42 +13,13 @@ ease and flexibility. --- This theme is adopted and finalized with new functionality from -[Jekyll][jekyll] [Ed][ed-original] theme by [Alex Gil][gil-twitter]. - -## Introduction - -One of our most pressing and ever-evolving needs as scholars is to -pass on our textual artifacts from one generation to another. The art of -textual editing, among otherpractices, has helped many cultures to remember -and interpret for centuries. Alas, that art is practiced and encouraged in its -highest form by a dwindling number of scholars. In a digital environment the -problem is compounded by the difficulties of the medium. While vast -repositories and "e-publications" appear on the online scene yearly, very few -manifest a textual scholar's disciplined attention to detail. In contrast, most -textual scholars who have made the leap to a rigorous digital practice have -focused on markup, relying on technical teams to deploy and maintain their -work. This makes your average scholarly digital edition a very costly and -therefore limited affair. - -As we see it, a minimal edition is one that aims to reduce the size and -complexity of the back and front end while flattening the learning curves for -the user and the producer. Out of the box, the Ed theme can help you build a -simple reading edition, or a traditional scholarly edition with footnotes and -a bibliography, without breaking the bank. In our estimate, these are the two -most immediately useful type of editions for editors and readers. An edition -produced with Ed consists of static pages whose rate of decay is substantially -lower than database-driven systems. As an added bonus, these static pages -require less bandwidth. Our hope is that our approach can help beginners and -veterans deploy beautiful editions with less effort, and that it can help us -teach a 'full stack' [in one academic semester][minimal-editions], while -allowing us to care for our projects at less cost, and perhaps, just perhaps, -to generate high-quality editions on github.io in large quantities based on the -[git-lit][git-lit] model by Jonathan Reeve. We're coming for you, Kindle! +[Jekyll](https://jekyllrb.com) [Ed](https://github.com/minicomp/ed) +theme by [Alex Gil](https://twitter.com/elotroalex). ## Sample Ed editions -- [Our sample site][sample-site] is the first edition built with Ed. -- [Serghei Iakovlev's blog][blog] +- [Our sample site](https://gohugo-theme-ed.netlify.app/) is the first edition built with Ed. +- [Serghei Iakovlev's blog](https://serghei.blog/?utm_source=ed&utm_campaign=docs&utm_medium=smm) ## Features @@ -62,21 +33,9 @@ to generate high-quality editions on github.io in large quantities based on the - Metadata in OpenGraph to play nice with social media and search engines - Automatic table of content generation - Contact form +- Custom `robots.txt` (changes values based on environment) +- RSS/Atom/Json Feeds Discovery ## License -Ed licensed under the MIT License. See the [LICENSE][license] file for more -information. - -[hugo]: http://gohugo.io -[mincomp]: http://go-dh.github.io/mincomp/ -[jekyll]: https://jekyllrb.com -[ed-original]: https://github.com/minicomp/ed -[gil-twitter]: https://twitter.com/elotroalex -[minimal-editions]: https://github.com/susannalles/MinimalEditions/blob/master/README.md -[git-lit]: http://jonreeve.com/2015/09/introducing-git-lit/ -[sample-site]: https://gohugo-theme-ed.netlify.app/ -[blog]: https://serghei.blog/?utm_source=ed&utm_campaign=docs&utm_medium=smm -[example-site]: https://github.com/sergeyklay/gohugo-theme-ed/tree/master/exampleSite -[config-sample]: https://github.com/sergeyklay/gohugo-theme-ed/blob/master/exampleSite/config.toml -[license]: https://raw.githubusercontent.com/sergeyklay/gohugo-theme-ed/master/LICENSE +Ed licensed under the MIT License. See the [LICENSE](https://raw.githubusercontent.com/sergeyklay/gohugo-theme-ed/master/LICENSE) file for more information. diff --git a/exampleSite/content/about.md b/exampleSite/content/about.md index f900d71..971f70d 100644 --- a/exampleSite/content/about.md +++ b/exampleSite/content/about.md @@ -46,6 +46,8 @@ for you, Kindle! - Metadata in OpenGraph to play nice with social media and search engines - Automatic table of content generation - Contact form +- Custom `robots.txt` (changes values based on environment) +- RSS/Atom/Json Feeds Discovery ## Installing and using Ed |