diff options
| author | Serghei Iakovlev <egrep@protonmail.ch> | 2022-05-28 15:48:51 +0200 |
|---|---|---|
| committer | Serghei Iakovlev <egrep@protonmail.ch> | 2022-05-28 15:48:51 +0200 |
| commit | ab124791bbeb470a51ea31dd31d806af5ce97ee3 (patch) | |
| tree | 8cf4f3cd4425915ed9500d8f8465438ed952d659 | |
| parent | 6b2b8e81e631a1fec44bdb94d5177cf5c56287c9 (diff) | |
| download | gohugo-theme-ed-ab124791bbeb470a51ea31dd31d806af5ce97ee3.tar.gz | |
Simplified documentation
| -rw-r--r-- | exampleSite/content/.gitignore | 1 | ||||
| -rw-r--r-- | exampleSite/content/_index.md | 2 | ||||
| -rw-r--r-- | exampleSite/content/about.md | 8 | ||||
| -rw-r--r-- | exampleSite/content/credits.md | 20 | ||||
| -rw-r--r-- | exampleSite/content/documentation/index.md | 26 | ||||
| -rw-r--r-- | exampleSite/content/narratives/narrative.md | 2 | ||||
| -rw-r--r-- | exampleSite/content/poems/a-julia.md | 2 |
7 files changed, 31 insertions, 30 deletions
diff --git a/exampleSite/content/.gitignore b/exampleSite/content/.gitignore new file mode 100644 index 0000000..4bacfcc --- /dev/null +++ b/exampleSite/content/.gitignore @@ -0,0 +1 @@ +fake*.md diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index 8b5e280..d950297 100644 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -4,4 +4,4 @@ title: "Ed." # hi. -Ed is a {{< link src="http://gohugo.io" target="_blank" rel="noopener noreferrer" >}}Hugo{{< /link >}} theme designed for textual editors based on {{< link src="http://go-dh.github.io/mincomp/" target="_blank" rel="noopener noreferrer" >}}minimal computing principles{{< /link >}}, and focused on legibility, durability, ease and flexibility. Our underlying technology is easy to learn and teach, and can produce beautifully rendered scholarly or reading editions of texts meant to last. To start using Ed, please see [our documentation]({{< relref "/documentation" >}}) for installation instructions and more. To learn more about the ideas behind Ed and a list of current features see our [about]({{< relref "/about" >}}) section. To see Ed in action, we've provided some sample minimal editions for you below. +Ed is a [Hugo](http://gohugo.io) theme designed for textual editors based on [minimal computing principles](http://go-dh.github.io/mincomp/), and focused on legibility, durability, ease and flexibility. Our underlying technology is easy to learn and teach, and can produce beautifully rendered scholarly or reading editions of texts meant to last. To start using Ed, please see [our documentation]({{< relref "/documentation" >}}) for installation instructions and more. To learn more about the ideas behind Ed and a list of current features see our [about]({{< relref "/about" >}}) section. To see Ed in action, we've provided some sample minimal editions for you below. diff --git a/exampleSite/content/about.md b/exampleSite/content/about.md index 971f70d..b8fa060 100644 --- a/exampleSite/content/about.md +++ b/exampleSite/content/about.md @@ -22,17 +22,17 @@ useful type of editions for editors and readers. An edition produced with Ed con 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' -{{< link src="https://github.com/susannalles/MinimalEditions/blob/master/README.md" target="_blank" rel="noopener noreferrer" >}}in one academic semester{{< /link >}}, +[in one academic semester](https://github.com/susannalles/MinimalEditions/blob/master/README.md), 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 -{{< link src="http://jonreeve.com/2015/09/introducing-git-lit/" target="_blank" rel="noopener noreferrer" >}}git-lit{{< /link >}} model by Jonathan Reeve. We're coming +[git-lit](http://jonreeve.com/2015/09/introducing-git-lit/) model by Jonathan Reeve. We're coming for you, Kindle! ## Sample Ed editions. -- {{< link src="https://gohugo-theme-ed.netlify.app/" target="_blank" rel="noopener noreferrer" >}}Our sample site{{< /link >}} is the first edition built with Ed. -- {{< link src="https://serghei.blog/?utm_source=ed&utm_campaign=docs&utm_medium=smm" target="_blank" rel="noopener noreferrer" >}}Serghei Iakovlev's blog{{< /link >}} +- [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) ## Current Features diff --git a/exampleSite/content/credits.md b/exampleSite/content/credits.md index 3a0dd33..1e7446f 100644 --- a/exampleSite/content/credits.md +++ b/exampleSite/content/credits.md @@ -2,35 +2,35 @@ title: Credits --- -### {{< link src="https://www.linkedin.com/in/egrep/" target="_blank" rel="noopener noreferrer" >}}Serghei Iakovlev{{< /link >}} | Software Engineer +### [Serghei Iakovlev](https://www.linkedin.com/in/egrep/) | Software Engineer -Serghei Iakovlev is a software engineer with 20 years of experience in IT who enjoys finding elegant solutions to non-trivial problems. Serghei focused on the goal and driven by visual sophistication and laser-sharp precision, he take pride in every finished project, and never stop learning along the way. Seghei work as the Head Of Development with 20 teams of 90+ engineers to develop {{< link src="https://airslate.com" target="_blank" rel="noopener noreferrer" >}}airSlate{{< /link >}} --- better nocode workflow automation platform. +Serghei Iakovlev is a software engineer with 20 years of experience in IT who enjoys finding elegant solutions to non-trivial problems. Serghei focused on the goal and driven by visual sophistication and laser-sharp precision, he take pride in every finished project, and never stop learning along the way. Seghei work as the Head Of Development with 20 teams of 90+ engineers to develop [airSlate](https://airslate.com) --- better nocode workflow automation platform. -### {{< link src="http://susannalles.github.io/" target="_blank" rel="noopener noreferrer" >}}Susanna Allés Torrent{{< /link >}} | Hyper philologist +### [Susanna Allés Torrent](http://susannalles.github.io/) | Hyper philologist Susanna teaches Digital Humanities in the Department of Latin American and Iberian Cultures. She earned her Ph.D in Romance Studies at the University of Barcelona in 2012, and completed a M.A. in «Nouvelles technologies appliquées à l’histoire» at the École Nationale des Chartes (Paris). She has taught at the University of Barcelona and she has been a postdoctoral fellow at the Spanish National Research Council (CSIC). Her research explores several aspects of digital humanities, especially, scholarly digital editions, electronic text analysis, intertextuality and text reuse, and digital lexicography. She also works with the intersection of the Iberian Peninsula and Italy in the Middle Ages and the Renaissance, reconstructing cultural and literary networks between the two. -### {{< link src="https://github.com/tcatapano" target="_blank" rel="noopener noreferrer" >}}Terry Catapano{{< /link >}} | Metadata ninja +### [Terry Catapano](https://github.com/tcatapano) | Metadata ninja Terry Catapano is a Librarian in Columbia University Libraries' Digital Program Division. He was Chair of the Society of American Archivists' Schema Development Team, responsible for the development of Encoded Archival Description version 3, and is a member of the ArchivesSpace Technical Advisory Group and the Editorial Board for the Metadata Encoding and Transmission Standard (METS). As Vice President of Plazi Verein, he leads the development of the TaxPub extension of the National Library of Medicine/National Center for Biotechnology Information Journal Publishing DTD, and has worked on digitizing, text mining, and providing open access to the literature of biological systematics, including collaborations with WikiData, the Encylopedia of Life, the Global Biodiversity Information Facility (GBIF), ZooBank, and CERN. -### {{< link src="http://www.elotroalex.com/" target="_blank" rel="noopener noreferrer" >}}Alex Gil{{< /link >}} | Resident minimalist +### [Alex Gil](http://www.elotroalex.com/) | Resident minimalist -Alex is the Digital Scholarship Coordinator for the Humanities and History at Columbia University. He is vice chair of the {{< link src="http://www.globaloutlookdh.org/" target="_blank" rel="noopener noreferrer" >}}Global Outlook::Digital Humanities{{< /link >}} initiative focusing on minimal computing and translation, is one of the founders and directors of {{< link src="http://xpmethod.plaintext.in/" target="_blank" rel="noopener noreferrer" >}}Columbia's Group for Experimental Methods in the Humanities{{< /link >}} and the {{< link src="https://studio.cul.columbia.edu/" target="_blank" rel="noopener noreferrer" >}}Studio@Butler{{< /link >}}, and is actively engaged in several digital humanities projects at Columbia and around the world. +Alex is the Digital Scholarship Coordinator for the Humanities and History at Columbia University. He is vice chair of the [Global Outlook::Digital Humanities](http://www.globaloutlookdh.org/) initiative focusing on minimal computing and translation, is one of the founders and directors of [Columbia's Group for Experimental Methods in the Humanities](http://xpmethod.plaintext.in/) and the [Studio@Butler](https://studio.cul.columbia.edu/), and is actively engaged in several digital humanities projects at Columbia and around the world. -### {{< link src="https://github.com/JohannGillium" target="_blank" rel="noopener noreferrer" >}}Johann Gillium{{< /link >}} | Search master +### [Johann Gillium](https://github.com/JohannGillium) | Search master -After having studied digital humanities at the Ecole nationale des Chartes in Paris, Johann has worked in France as a librarian at the Bibliothèque interuniversaire de Santé, where he most notably contributed to the {{< link src="http://www3.biusante.parisdescartes.fr/vesale/debut.htm" target="_blank" rel="noopener noreferrer" >}}Vesalius project{{< /link >}}, the digital edition of several works by the great anatomist Andreas Vesalius. +After having studied digital humanities at the Ecole nationale des Chartes in Paris, Johann has worked in France as a librarian at the Bibliothèque interuniversaire de Santé, where he most notably contributed to the [Vesalius project](http://www3.biusante.parisdescartes.fr/vesale/debut.htm), the digital edition of several works by the great anatomist Andreas Vesalius. --- ## Acknowledgments -As many open source projects, Ed is the work of community. The project starts with the open web, and everything in between leading to {{< link src="https://gohugo.io/" target="_blank" rel="noopener noreferrer" >}}Hugo{{< /link >}} and the wonderful team who wrangled that Go in our favor. This theme is adopted and finalized with new functionality from {{< link src="https://jekyllrb.com/" target="_blank" rel="noopener noreferrer" >}}Jekyll{{< /link >}} {{< link src="https://github.com/minicomp/ed" target="_blank" rel="noopener noreferrer" >}}Ed{{< /link >}} theme by {{< link src="ttps://twitter.com/elotroalex" target="_blank" rel="noopener noreferrer" >}}Alex Gil{{< /link >}}. The original Ed theme stylesheets are built on top of {{< link src="https://github.com/poole/lanyon" target="_blank" rel="noopener noreferrer" >}}Lanyon{{< /link >}}, a Jekyll theme based on {{< link src="http://getpoole.com" target="_blank" rel="noopener noreferrer" >}}Poole{{< /link >}}, "the Jekyll butler," both created by {{< link src="https://github.com/mdo" target="_blank" rel="noopener noreferrer" >}}Mark Otto{{< /link >}} and distributed with an MIT license. Thanks, Mark, for your helpful streamlining! Special hat tips to brother-in-markdown-arms, {{< link src="https://github.com/c-forster" target="_blank" rel="noopener noreferrer" >}}Chris Forster{{< /link >}}, and the generous {{< link src="https://github.com/inukshuk/" target="_blank" rel="noopener noreferrer" >}}Sylvester Keil{{< /link >}} for his work on Jekyll Scholar. +As many open source projects, Ed is the work of community. The project starts with the open web, and everything in between leading to [Hugo](https://gohugo.io/) and the wonderful team who wrangled that Go in our favor. This theme is adopted and finalized with new functionality from [Jekyll](https://jekyllrb.com/) [Ed](https://github.com/minicomp/ed) theme by [Alex Gil](ttps://twitter.com/elotroalex). The original Ed theme stylesheets are built on top of [Lanyon](https://github.com/poole/lanyon), a Jekyll theme based on [Poole](http://getpoole.com), "the Jekyll butler," both created by [Mark Otto](https://github.com/mdo) and distributed with an MIT license. Thanks, Mark, for your helpful streamlining! Special hat tips to brother-in-markdown-arms, [Chris Forster](https://github.com/c-forster), and the generous [Sylvester Keil](https://github.com/inukshuk/) for his work on Jekyll Scholar. -We are strongly indebted to the research work and conversations stemming out of our {{< link src="http://xpmethod.plaintext.in/" target="_blank" rel="noopener noreferrer" >}}Columbia's Group for Experimental Methods in the Humanities{{< /link >}}—or as we like to call it: \#xpmethod; the wonderful international comradery of {{< link src="http://www.globaloutlookdh.org/" target="_blank" rel="noopener noreferrer" >}}GO::DH{{< /link >}}; and of course, the support of our {{< link src="http://library.columbia.edu/" target="_blank" rel="noopener noreferrer" >}}Columbia University Libraries{{< /link >}} and its cozy {{< link src="https://studio.cul.columbia.edu/" target="_blank" rel="noopener noreferrer" >}}Studio@Butler{{< /link >}}. +We are strongly indebted to the research work and conversations stemming out of our [Columbia's Group for Experimental Methods in the Humanities](http://xpmethod.plaintext.in/)—or as we like to call it: \#xpmethod; the wonderful international comradery of [GO::DH](http://www.globaloutlookdh.org/); and of course, the support of our [Columbia University Libraries](http://library.columbia.edu/) and its cozy [Studio@Butler](https://studio.cul.columbia.edu/). ...and to the writers that inspire us to scribble notes on the margins we protect with our work. Thank you. diff --git a/exampleSite/content/documentation/index.md b/exampleSite/content/documentation/index.md index 7428906..dd3febc 100644 --- a/exampleSite/content/documentation/index.md +++ b/exampleSite/content/documentation/index.md @@ -13,15 +13,15 @@ featured_image: screenshot-home.png This documentation was built with beginners in mind, but has the necessary information for more seasoned producers. -To install and use Ed you will be using your terminal. If you need a refresher, I highly recommend "{{< link src="https://www.computervillage.org/articles/CommandLine.pdf" target="_blank" rel="noopener noreferrer" >}}The Command Line Crash Course{{< /link >}}." Working knowledge of HTML and CSS is also taken for granted. If you're new to HTML and CSS, you may want to check out the relevant courses on {{< link src="https://www.codecademy.com/learn/web" target="_blank" rel="noopener noreferrer" >}}codecademy.com{{< /link >}}. +To install and use Ed you will be using your terminal. If you need a refresher, I highly recommend "[The Command Line Crash Course](https://www.computervillage.org/articles/CommandLine.pdf)." Working knowledge of HTML and CSS is also taken for granted. If you're new to HTML and CSS, you may want to check out the relevant courses on [codecademy.com](https://www.codecademy.com/learn/web). --- ## Installing Ed -Before starting, please be sure that you have {{< link src="https://gohugo.io/getting-started/quick-start/#step-1-install-hugo" target="_blank" rel="noopener noreferrer" >}}installed Hugo{{< /link >}} and {{< link src="https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site" target="_blank" rel="noopener noreferrer" >}}created a new site{{< /link >}}. After that, you are ready to install Ed. +Before starting, please be sure that you have [installed Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and [created a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site). After that, you are ready to install Ed. -The first step to install Ed is to download the source files from GitHub. To do so you must have git installed on your computer. You probably have git already, but if you don't, the easiest way is probably to install {{< link src="https://desktop.github.com/" target="_blank" rel="noopener noreferrer" >}}Github Desktop{{< /link >}} (even though we will be using git and github from the terminal in this tutorial). Mac users may want to ensure they have {{< link src="https://developer.apple.com/xcode/" target="_blank" rel="noopener noreferrer" >}}Xcode{{< /link >}} and its command line tools installed as well. To check if git is running on your system enter the following line on your terminal (remember to ignore the $): +The first step to install Ed is to download the source files from GitHub. To do so you must have git installed on your computer. You probably have git already, but if you don't, the easiest way is probably to install [Github Desktop](https://desktop.github.com/) (even though we will be using git and github from the terminal in this tutorial). Mac users may want to ensure they have [Xcode](https://developer.apple.com/xcode/) and its command line tools installed as well. To check if git is running on your system enter the following line on your terminal (remember to ignore the $): ~~~ bash $ git --version @@ -49,7 +49,7 @@ After installing the theme successfully it requires a just a few more steps to g ### The config file -Take a look inside the {{< link src="https://github.com/sergeyklay/gohugo-theme-ed/tree/master/exampleSite" target="_blank" rel="noopener noreferrer" >}}`exampleSite`{{< /link >}} folder of this theme. You'll find a file called {{< link src="https://github.com/sergeyklay/gohugo-theme-ed/blob/master/exampleSite/config.toml" target="_blank" rel="noopener noreferrer" >}}`config.toml`{{< /link >}}. To use it, copy the {{< link src="https://github.com/sergeyklay/gohugo-theme-ed/blob/master/exampleSite/config.toml" target="_blank" rel="noopener noreferrer" >}}`config.toml`{{< /link >}} in the root folder of your Hugo site. Feel free to change the strings in this theme. +Take a look inside the [`exampleSite`](https://github.com/sergeyklay/gohugo-theme-ed/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/sergeyklay/gohugo-theme-ed/blob/master/exampleSite/config.toml). To use it, copy the [`config.toml`](https://github.com/sergeyklay/gohugo-theme-ed/blob/master/exampleSite/config.toml) in the root folder of your Hugo site. Feel free to change the strings in this theme. You may need to delete the line: `themesDir = "../.."`, because it's necessary only for theme developers. Also, make sure the theme option is set to `ed`: @@ -71,9 +71,9 @@ Copy the url from your terminal log and paste it into your browser of choice. Th ## Hugo -Ed is a Hugo theme. That means you will need some familiarity with Hugo to take advantage of its full potential. While running a Hugo site is a bit more involved than Wordpress and other similar tools, the payoff in the long term is worth the effort to learn it. If you are new to Hugo, I recommend you take a look at {{< link src="https://strapi.io/blog/guide-to-using-hugo-site-generator" target="_blank" rel="noopener noreferrer" >}}A Guide to Using Hugo{{< /link >}} at *Strapi*, {{< link src="https://gohugo.io/hosting-and-deployment/hosting-on-github/" target="_blank" rel="noopener noreferrer" >}}Host on GitHub{{< /link >}} on *Hugo Documentation Site* and {{< link src="https://gohugo.io/documentation/" target="_blank" rel="noopener noreferrer" >}}Hugo's own documentation{{< /link >}} to start getting a sense of how it works. +Ed is a Hugo theme. That means you will need some familiarity with Hugo to take advantage of its full potential. While running a Hugo site is a bit more involved than Wordpress and other similar tools, the payoff in the long term is worth the effort to learn it. If you are new to Hugo, I recommend you take a look at [A Guide to Using Hugo](https://strapi.io/blog/guide-to-using-hugo-site-generator) at *Strapi*, [Host on GitHub](https://gohugo.io/hosting-and-deployment/hosting-on-github/) on *Hugo Documentation Site* and [Hugo's own documentation](https://gohugo.io/documentation/) to start getting a sense of how it works. -Once you have gone through these tutorials, you can get started using Ed. Remember to always and only edit content files for your site using {{< link src="https://en.wikipedia.org/wiki/Text_editor" target="_blank" rel="noopener noreferrer" >}}a plain text editor{{< /link >}}, and *not* a word processor. I'm composing this file using a plain text editor called {{< link src="https://code.visualstudio.com/" target="_blank" rel="noopener noreferrer" >}}Visual Studio Code{{< /link >}}. +Once you have gone through these tutorials, you can get started using Ed. Remember to always and only edit content files for your site using [a plain text editor](https://en.wikipedia.org/wiki/Text_editor), and *not* a word processor. I'm composing this file using a plain text editor called [Visual Studio Code](https://code.visualstudio.com/). You should make sure that all your texts have the YAML front matter (the information at the top of the file). YAML stands for "YAML Ain't Markup Language" --- no disrespect to XML --- and it's the main way that Hugo handles named data. Here's an example of YAML front matter: @@ -89,9 +89,9 @@ draft: true ## Markdown and CommonMark -Ed is designed for scholars and amateur editors who want to produce either a clean reading edition or a scholarly annotated edition of a text. The main language we use to write in the Hugo environment is called Markdown. To learn more about the Markdown family, see Dennis Tenen and Grant Wythoff's "{{< link src="http://programminghistorian.org/lessons/sustainable-authorship-in-plain-text-using-pandoc-and-markdown" target="_blank" rel="noopener noreferrer" >}}Sustainable Authorship in Plain Text using Pandoc and Markdown{{< /link >}}." +Ed is designed for scholars and amateur editors who want to produce either a clean reading edition or a scholarly annotated edition of a text. The main language we use to write in the Hugo environment is called Markdown. To learn more about the Markdown family, see Dennis Tenen and Grant Wythoff's "[Sustainable Authorship in Plain Text using Pandoc and Markdown](http://programminghistorian.org/lessons/sustainable-authorship-in-plain-text-using-pandoc-and-markdown)." -By default Hugo uses a special Markdown processor called Goldmark. The processor can be said to use it's own 'flavor' of Markdown called CommonMark, and sometimes the Markdown syntax will be different than other flavors of Markdown. CommonMark is a rationalized version of Markdown syntax with a spec whose goal is to remove the ambiguities and inconsistency surrounding the original Markdown specification. It offers a standardized specification that defines the common syntax of the language along with a suite of comprehensive tests to validate Markdown implementations against this specification. You can become familiar with the CommonMark syntax in the {{< link src="https://spec.commonmark.org/" target="_blank" rel="noopener noreferrer" >}}CommonMark documentation{{< /link >}}. Another way to become familiar is to examine the sample text source files we provided. +By default Hugo uses a special Markdown processor called Goldmark. The processor can be said to use it's own 'flavor' of Markdown called CommonMark, and sometimes the Markdown syntax will be different than other flavors of Markdown. CommonMark is a rationalized version of Markdown syntax with a spec whose goal is to remove the ambiguities and inconsistency surrounding the original Markdown specification. It offers a standardized specification that defines the common syntax of the language along with a suite of comprehensive tests to validate Markdown implementations against this specification. You can become familiar with the CommonMark syntax in the [CommonMark documentation](https://spec.commonmark.org/). Another way to become familiar is to examine the sample text source files we provided. --- @@ -228,15 +228,15 @@ The `{.poetry}` tag at the end tells the processor to think of the lines above i ## Pages -Your editions are treated as {{< link src="https://gohugo.io/content-management/sections/" target="_blank" rel="noopener noreferrer" >}}sections{{< /link >}} or {{< link src="https://gohugo.io/content-management/page-bundles/" target="_blank" rel="noopener noreferrer" >}}page bundles{{< /link >}} in Ed. Other web pages in your site exist outside the `content` folder. Default homepage, for example, is constructed from the `index.html` file found on the `layouts` folder of Ed theme. +Your editions are treated as [sections](https://gohugo.io/content-management/sections/) or [page bundles](https://gohugo.io/content-management/page-bundles/) in Ed. Other web pages in your site exist outside the `content` folder. Default homepage, for example, is constructed from the `index.html` file found on the `layouts` folder of Ed theme. -You will notice that the homepage in particular has a `.html` file ending instead of a `.md` ending. All template files in Hugo are HTML, and the index behaves as a template file. Although these files are mostly written in HTML, notice that they may contain {{< link src="https://gohugo.io/templates/introduction/" target="_blank" rel="noopener noreferrer" >}}template tags{{< /link >}}. To create your own homepage create `index.html` file in project `layouts` folder, making sure that your changes to `index.html` are written in valid HTML. The same goes for all Ed's template files in the `layouts` folder. +You will notice that the homepage in particular has a `.html` file ending instead of a `.md` ending. All template files in Hugo are HTML, and the index behaves as a template file. Although these files are mostly written in HTML, notice that they may contain [template tags](https://gohugo.io/templates/introduction/). To create your own homepage create `index.html` file in project `layouts` folder, making sure that your changes to `index.html` are written in valid HTML. The same goes for all Ed's template files in the `layouts` folder. --- ## Tables of Content -You will find three kinds of Tables of Content in Ed. The first example is in the list of Latest Publications in the Homepage. This list is generated using the {{< link src="https://gohugo.io/templates/introduction/" target="_blank" rel="noopener noreferrer" >}}templating language{{< /link >}}. This is one of the major components of Hugo, and I recommend you deepen your knowledge of it if you want to modify the logic that automates much of Ed. Here is the code that generates the Latest Publications list on the homepage: +You will find three kinds of Tables of Content in Ed. The first example is in the list of Latest Publications in the Homepage. This list is generated using the [templating language](https://gohugo.io/templates/introduction/). This is one of the major components of Hugo, and I recommend you deepen your knowledge of it if you want to modify the logic that automates much of Ed. Here is the code that generates the Latest Publications list on the homepage: ~~~ html <div class="toc"> @@ -253,7 +253,7 @@ You will find three kinds of Tables of Content in Ed. The first example is in th As you can see, the templating tags `{{ }}` are embedded into the HTML. These tags often use programmatic logic, as is the case here. However, another use of these tags is pull data from your project. In the example above it pulls the `Title` from each allowed post type. -As you may have noticed already, we are basically adapting the blogging features of Hugo to our own ends, what Cuban designer and theorist Ernesto Oroza would call "{{< link src="http://www.ernestooroza.com/" target="_blank" rel="noopener noreferrer" >}}technological dissobedience{{< /link >}}." +As you may have noticed already, we are basically adapting the blogging features of Hugo to our own ends, what Cuban designer and theorist Ernesto Oroza would call "[technological dissobedience](http://www.ernestooroza.com/)." The second kind of table of content is exemplified in this documentation. If you open the source file for the documentation, you will notice at the top this snippet: @@ -279,7 +279,7 @@ The internal links pointing to the right sections in your document are generated --- -That should do it. If you have suggestions on how to improve Ed, make sure to leave us a line on {{< link src="https://github.com/sergeyklay/gohugo-theme-ed/issues" target="_blank" rel="noopener noreferrer" >}}our issues page{{< /link >}}, or send us a pull request. +That should do it. If you have suggestions on how to improve Ed, make sure to leave us a line on [our issues page](https://github.com/sergeyklay/gohugo-theme-ed/issues), or send us a pull request. Happy editing! diff --git a/exampleSite/content/narratives/narrative.md b/exampleSite/content/narratives/narrative.md index d08961b..c6d123e 100644 --- a/exampleSite/content/narratives/narrative.md +++ b/exampleSite/content/narratives/narrative.md @@ -29,7 +29,7 @@ toc: ## Editor's note -This version of *Narrative of the Life of Frederick Douglass* was adapted from *The Project Gutenberg EBook of The Narrative of the Life of Frederick Douglass, by Frederick Douglass*. The {{< link src="http://www.gutenberg.org/" target="_blank" rel="noopener noreferrer" >}}Guttenberg file{{< /link >}} does not tell us which witness was used in making their digital edition. The edition below is only a slightly modified version of the Guttenberg text, and therefore should not be taken too seriously as an edition. I use the text mostly to show a few affordances of using Ed for long form narrative. This page, for example, showcases a different sidebar than the rest of our sample site, with a table of content of the novel generated out of metadata in the source file. In addition, reading morsels of the novel on your different devices can give you a sense of the experience of reading prose using Ed, and shows you an example of the optional sidebar with a table of contents. A few other features of this page are described in more detail in the [Documentation]({{< relref "/documentation" >}}). +This version of *Narrative of the Life of Frederick Douglass* was adapted from *The Project Gutenberg EBook of The Narrative of the Life of Frederick Douglass, by Frederick Douglass*. The [Guttenberg file](http://www.gutenberg.org/) does not tell us which witness was used in making their digital edition. The edition below is only a slightly modified version of the Guttenberg text, and therefore should not be taken too seriously as an edition. I use the text mostly to show a few affordances of using Ed for long form narrative. This page, for example, showcases a different sidebar than the rest of our sample site, with a table of content of the novel generated out of metadata in the source file. In addition, reading morsels of the novel on your different devices can give you a sense of the experience of reading prose using Ed, and shows you an example of the optional sidebar with a table of contents. A few other features of this page are described in more detail in the [Documentation]({{< relref "/documentation" >}}). --- diff --git a/exampleSite/content/poems/a-julia.md b/exampleSite/content/poems/a-julia.md index ab6309b..f07641a 100644 --- a/exampleSite/content/poems/a-julia.md +++ b/exampleSite/content/poems/a-julia.md @@ -12,7 +12,7 @@ source: Ciudad Seva - Mienten, *Julia de Burgos*. Mienten, Julia de Burgos. - La que se alza en mis versos no es tu voz: es mi voz -- porque tú eres {{< link src="http://www.spanishdict.com/translate/ropaje" target="_blank" rel="noopener noreferrer" >}}ropaje{{< /link >}} y la esencia soy yo; y el más +- porque tú eres [ropaje](http://www.spanishdict.com/translate/ropaje) y la esencia soy yo; y el más - profundo abismo se tiende entre las dos. - Tú eres fria muñeca de mentira social, |
