diff --git a/.gitmodules b/.gitmodules index c9a1269..7033986 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +1,6 @@ +[submodule "doc/themes/hugo-onyx-theme"] + path = doc/themes/hugo-onyx-theme + url = https://github.com/kaushalmodi/hugo-onyx-theme [submodule "test/site/themes/bare_min"] path = test/site/themes/bare_min url = https://github.com/kaushalmodi/hugo-bare-min-theme diff --git a/doc/config.toml b/doc/config.toml index cf1bd9c..79c9546 100644 --- a/doc/config.toml +++ b/doc/config.toml @@ -1,7 +1,7 @@ baseURL = "http://example.org/" Title = "ox-hugo - Org to Hugo exporter" -theme = "hugo-alabaster-theme" +theme = "hugo-onyx-theme" contentdir = "content" layoutdir = "layouts" @@ -48,7 +48,7 @@ disableFastRender = true # Hugo 0.30 doc = "/doc/:filename/" test = "/test/:slug/" -[params] +[Params] name = "ox-hugo" description = "Org mode to Hugo exporter
Write your Hugo posts in native Org mode." @@ -74,26 +74,25 @@ disableFastRender = true # Hugo 0.30 ] custom_js = [] - # highlightjs = "css/highlight.css" # favicon = "favicon.ico" -[params.sidebar] - logo = "favicon.ico" + [Params.source] + url = "https://github.com/kaushalmodi/ox-hugo" + org_dir = "doc" + org_file = "doc/ox-hugo-manual.org" - github_button = true - travis_button = true - codecov_button = false - gratipay = "" + [Params.sidebar] + logo = "favicon.ico" - # Mon Sep 04 23:55:36 EDT 2017 - kmodi - # Disable this option for now.. but seems to be useful in future - show_relations = false + github_button = true + travis_button = true + codecov_button = false + gratipay = "" -[params.footer] - copyright = "" - show_powered_by = true + # Mon Sep 04 23:55:36 EDT 2017 - kmodi + # Disable this option for now.. but seems to be useful in future + show_relations = false -# Blackfriday is Hugo's markdown engine. -# https://gohugo.io/overview/configuration/#configure-blackfriday-rendering -[blackfriday] - hrefTargetBlank = true # open external links in a new window or tab + [Params.footer] + copyright = "" + show_powered_by = true diff --git a/doc/themes/hugo-alabaster-theme/LICENSE.md b/doc/themes/hugo-alabaster-theme/LICENSE.md deleted file mode 100644 index d1ca429..0000000 --- a/doc/themes/hugo-alabaster-theme/LICENSE.md +++ /dev/null @@ -1,34 +0,0 @@ -Copyright (c) 2016 Digitalcraftsman - -Based on original work copyright (c) Jeff Forcier, copyright (c) 2011 Kenneth Reitz -and copyright (c) 2010 Armin Ronacher. - -Some rights reserved. - -Redistribution and use in source and binary forms of the theme, with or -without modification, are permitted provided that the following conditions -are met: - -* Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above - copyright notice, this list of conditions and the following - disclaimer in the documentation and/or other materials provided - with the distribution. - -* The names of the contributors may not be used to endorse or - promote products derived from this software without specific - prior written permission. - -THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. diff --git a/doc/themes/hugo-alabaster-theme/README.md b/doc/themes/hugo-alabaster-theme/README.md deleted file mode 100644 index 2fd4691..0000000 --- a/doc/themes/hugo-alabaster-theme/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# Alabaster - -A documentation theme ported from [Sphinx](http://www.sphinx-doc.org/en/stable/) to [Hugo](https://gohugo.io). - -[![Screenshot](https://raw.githubusercontent.com/digitalcraftsman/hugo-alabaster-theme/dev/images/screenshot.png)](https://digitalcraftsman.github.io/hugo-alabaster-theme/) - -## Quick start - -Install with `git`: - -```sh -git clone git@github.com:digitalcraftsman/hugo-alabaster-theme.git themes/hugo-alabaster-theme -``` - -> This theme uses the latest developement version of Hugo. Therefore, it doesn't work with the official releases. Look [here](https://github.com/spf13/hugo#build-and-install-the-binaries-from-source-advanced-install) if you want to know how to build Hugo from source. - -Next, take a look in the `exampleSite` folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation. - -Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary. - -Hugo includes a development server, so you can view your changes as you go - -very handy. Spin it up with the following command: - -``` sh -hugo server -``` - -Now you can go to [localhost:1313](http://localhost:1313) and the Alabaster -theme should be visible. - -For detailed installation instructions visit the [demo](https://digitalcraftsman.github.io/hugo-alabaster-theme/). - -## Acknowledgements - -Last but not I want to give a big shout-out to [Jeff Forcier](https://github.com/bitprophet), [Kenneth Reitz](https://github.com/kennethreitz) and [Armin Ronacher](https://github.com/mitsuhiko). Their work and modifications on the original codebase made this port possible. - -Furthermore, thanks to [Steve Francia](https://gihub.com/spf13) for creating Hugo and the [awesome community](https://github.com/spf13/hugo/graphs/contributors) around the project. - - -## License - -The theme is released under the BSD license. Read the [license](https://github.com/digitalcraftsman/hugo-alabaster-theme/blob/master/LICENSE.md) for more information. diff --git a/doc/themes/hugo-alabaster-theme/layouts/404.html b/doc/themes/hugo-alabaster-theme/layouts/404.html deleted file mode 100644 index 6c298de..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/404.html +++ /dev/null @@ -1,5 +0,0 @@ -{{ define "main" }} -

Page not found

- - I'm sorry, but the requested page wasn’t found on the server. -{{ end }} \ No newline at end of file diff --git a/doc/themes/hugo-alabaster-theme/layouts/_default/baseof.html b/doc/themes/hugo-alabaster-theme/layouts/_default/baseof.html deleted file mode 100644 index 93310a3..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/_default/baseof.html +++ /dev/null @@ -1,33 +0,0 @@ - - - {{ partial "head" . }} - -
-
-
-
- {{ block "main" . }}{{ end }} - - {{ if not .IsHome -}} - {{ template "_internal/disqus.html" . }} - {{ end }} -
-
-
- - {{ partial "sidebar/sidebar" . }} - {{ partial "footer" . }} - - {{ range .Site.Params.custom_js -}} - - {{ end }} - - {{ with .Site.Params.highlightjs -}} - - - {{ end }} - - {{ template "_internal/google_analytics.html" . }} -
- - diff --git a/doc/themes/hugo-alabaster-theme/layouts/_default/single.html b/doc/themes/hugo-alabaster-theme/layouts/_default/single.html deleted file mode 100644 index 6157097..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/_default/single.html +++ /dev/null @@ -1,4 +0,0 @@ -{{ define "main" }} -

{{ .Title }}

-{{ partial "headline-hash.html" .Content }} -{{ end }} diff --git a/doc/themes/hugo-alabaster-theme/layouts/index.html b/doc/themes/hugo-alabaster-theme/layouts/index.html deleted file mode 100644 index 66259e3..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/index.html +++ /dev/null @@ -1,11 +0,0 @@ -{{ define "main" }} -{{ range where .Site.Pages "Type" "homepage" }} -

{{ .Title }}

- {{ partial "headline-hash.html" .Content }} -{{ end }} - - - -{{/* partial "debugprint.html" $.Site.Menus */}} - -{{ end }} diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/footer.html b/doc/themes/hugo-alabaster-theme/layouts/partials/footer.html deleted file mode 100644 index b9c77dd..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/footer.html +++ /dev/null @@ -1,19 +0,0 @@ -
- {{ if .Site.Params.footer.show_powered_by }} - Exported from ox-hugo-manual.org - using - {{ with .Params.creator }} - {{ . | replaceRE "\\(Org.*" "" }} + - {{ . | replaceRE "Emacs.*\\(" "" | replaceRE "\\+ ox-.*" "" }} + - {{ end }} - ox-hugo - and published using Hugo {{ .Hugo.Version }} - + Alabaster - {{ end }} -
- -{{ if .Site.Params.github_banner }} - - Fork me on GitHub - -{{ end }} diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/head.html b/doc/themes/hugo-alabaster-theme/layouts/partials/head.html deleted file mode 100644 index b428b4f..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/head.html +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - - - {{ with .Site.Params.description }} - - {{ end }} - - {{ .Hugo.Generator }} - - {{ if not .IsHome }}{{ .Title }} —{{ end }} {{ .Site.Title }} - - - - {{ with .Site.Params.highlightjs }} - - {{ end }} - - {{ range .Site.Params.custom_css }} - - {{ end }} - - {{ range .Site.Params.custom_css_absolute }} - - {{ end }} - - {{ with .Site.Params.favicon }} - - {{ else }} - - {{ end }} - - {{ with .Params.mathjax }} - {{ partial "mathjax.html" }} - {{ end }} - - - {{ partial "opengraph.html" . }} - {{ partial "twitter_cards.html" . }} - diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/headline-hash.html b/doc/themes/hugo-alabaster-theme/layouts/partials/headline-hash.html deleted file mode 100644 index ac567ec..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/headline-hash.html +++ /dev/null @@ -1 +0,0 @@ -{{ . | replaceRE "()" "${1} # ${3}" | safeHTML }} diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/mathjax.html b/doc/themes/hugo-alabaster-theme/layouts/partials/mathjax.html deleted file mode 100644 index 272acad..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/mathjax.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/opengraph.html b/doc/themes/hugo-alabaster-theme/layouts/partials/opengraph.html deleted file mode 100644 index 881c386..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/opengraph.html +++ /dev/null @@ -1,92 +0,0 @@ -{{ $permalink := .Permalink }} - - - - -{{ with .Params.images }} - {{ range first 6 . }} - {{ $image := . }} - {{ $image_link_absolute := (findRE "^/" $image) }} - {{ if $image_link_absolute }} - - {{ else }} - - {{ end }} - {{ end }} -{{ end }} -{{ if .IsPage }} - {{ if not .PublishDate.IsZero }} - - {{ else if not .Date.IsZero }} - - {{ end }} - {{ if not .Lastmod.IsZero }} - - {{ end }} -{{ else }} - {{ if not .Date.IsZero }} - - {{ end }} -{{ end }} -{{ with .Params.audio }} - {{ $audio := . }} - {{ $audio_link_absolute := (findRE "^/" $audio) }} - {{ if $audio_link_absolute }} - - {{ else }} - - {{ end }} -{{ end }} -{{ with .Params.locale }} - -{{ end }} -{{ with .Site.Params.title }} - -{{ end }} -{{ with .Params.videos }} - {{ range . }} - {{ $video := . }} - {{ $video_link_absolute := (findRE "^/" $video) }} - {{ if $video_link_absolute }} - - {{ else }} - - {{ end }} - {{ end }} -{{ end }} - -{{ $siteSeries := .Site.Taxonomies.series }} -{{ if $siteSeries }} - {{ with .Params.series }} - {{ range $name := . }} - {{ $series := index $siteSeries $name }} - {{ range $page := first 6 $series.Pages }} - {{ if ne $page.Permalink $permalink }} - - {{ end }} - {{ end }} - {{ end }} - {{ end }} -{{ end }} - -{{ if .IsPage }} - {{ range .Site.Authors }} - {{ with .Social.facebook }} - - {{ end }} - {{ with .Site.Social.facebook }} - - {{ end }} - - {{ with .Params.tags }} - {{ range first 6 . }} - - {{ end }} - {{ end }} - {{ end }} -{{ end }} - -{{ with .Site.Social.facebook_admin }} - -{{ end }} diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/buttons.html b/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/buttons.html deleted file mode 100644 index 346bf1e..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/buttons.html +++ /dev/null @@ -1,26 +0,0 @@ -{{ if .Site.Params.github_user | and .Site.Params.github_repo }} - {{ $path := printf "%s/%s" .Site.Params.github_user .Site.Params.github_repo }} - - {{ if .Site.Params.sidebar.github_button }} - - {{ end }} - - {{ if .Site.Params.sidebar.travis_button }} -

- - https://secure.travis-ci.org/{{ $path }}.svg?branch=master - -

- {{ end }} - - {{ if .Site.Params.sidebar.codecov_button }} -

- - https://codecov.io/github/{{ $path }}/coverage.svg?branch=master - -

- {{ end }} -{{ end }} diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/donate.html b/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/donate.html deleted file mode 100644 index 894b6a0..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/donate.html +++ /dev/null @@ -1,7 +0,0 @@ -{{ with .Site.Params.sidebar.gratipay -}} -

Donate

-

-Consider supporting the authors on Gratipay: - -

-{{- end }} diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/menu.html b/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/menu.html deleted file mode 100644 index 7fea0f4..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/menu.html +++ /dev/null @@ -1,11 +0,0 @@ -{{ range $menu_name, $menu := .Site.Menus }} -

{{ $menu_name | replaceRE "^[0-9]+\\." "" | humanize | title }}

- -{{ end }} diff --git a/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/relations.html b/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/relations.html deleted file mode 100644 index d6073ff..0000000 --- a/doc/themes/hugo-alabaster-theme/layouts/partials/sidebar/relations.html +++ /dev/null @@ -1,12 +0,0 @@ -{{ if .Site.Params.sidebar.show_relations | and .IsPage -}} -

Related Topics

-