Commit graph

104 commits

Author SHA1 Message Date
derrygeoff
494dfa897f
Update README.md
Added instructions to add a hugo form on readme.MD
2022-05-30 09:55:20 +01:00
Alex Shpak
1852b16d93 #440L Adjust bookHref, check .Content again, add redirect 2022-04-26 13:14:22 +02:00
Samuel Redai
2f60f0919f
Updating book to hugo-book in README (#394)
Looks like the path `/book/` in the readme should be `/hugo-book/`.
2021-12-01 10:43:39 +01:00
QIN2DIM
c47eb7388a
Rename theme in readmin to hugo-book (#386)
* Update README.md
* Update README.md

Co-authored-by: Alex Shpak <alex-shpak@users.noreply.github.com>
2021-11-19 13:33:01 +01:00
Jack Morgan
9d4916fcc2
Allow site title to be customised via parital (#384)
* Allow site title to be customised via parital
* Modify readme to highlight available partials
* Rename template for consistency
* Move title tags to head partial
2021-09-27 09:36:02 +02:00
Alex Shpak
d6087bd32d Add hugo init to install instructions 2021-09-11 21:27:19 +02:00
Michael T Lombardi (He/Him)
6aef8ef1c7
(GH-375) Enable use as a hugo module (#376)
This commit does the minimal work to make the Book theme a functional
hugo module by adding the go.mod file and including instructions in
the project README for use.

Resolves #375
2021-09-07 22:05:33 +02:00
Alex Shpak
50147be131
Update README.md 2021-07-25 22:44:14 +02:00
Nikolay Raspopov
4540d66e3b
Document removal of internal hugo templates (#345) 2021-05-27 09:11:13 +02:00
Collin Brooks
ba38e17b1b
Add custom commit path for last edited link (#319)
- A new `BookCommitPath` paramter was added that allows the 'commit'
   portion of the link to a page's last edited commit hash to be
   specified.
 - This is useful when github is not the default repository for a
   project.

Co-authored-by: Collin Brooks <cbrooks@sentryds.com>
2021-04-11 17:50:54 +02:00
Collin Brooks
e2786374ad
Add documentation for mermaid init config override (#317)
* Add documentation for mermaid init config override
* Capitalize Mermaid

Co-authored-by: Collin Brooks <cbrooks@sentryds.com>
2021-04-11 17:49:09 +02:00
Alex Shpak
d9fe59a6e9 Refactor aside menus, add extra wrapper 2021-01-26 22:20:30 +01:00
Tiger Oakes
012ccee53d
Add before and after partials for toc (#296)
Closes #257
2021-01-26 18:45:08 +01:00
Alex Shpak
b76bdd715b #242, Add bookSearchExclude frontmatter param 2020-09-15 00:17:28 +02:00
Alex Shpak
4e34988b5d #151, move SCSS vars to CSS vars, implement dark and light modes by browser preference 2020-09-14 00:02:55 +02:00
Marie-Helene Burle
796468766f
Many minor fixes in README.md (#258)
- fix path of `menu/index.md` to match that given in the ExampleSite
- fix typos
- fix grammar
- add missing articles
2020-07-29 13:37:55 +02:00
Greg Kitson
5eceee52ed
fix minor typo in README.md under Site Configuration (#254) 2020-07-23 11:18:18 +02:00
Justin
d198d96b30
Enabling KaTex Instructions (#217)
* Enabling KaTex Instructions

This would have been really helpful if that was documented, many users aren't able to render the KaTex and aren't sure why/where to look
Also,  fixed spelling some spelling

* Update README.md

Co-authored-by: Alex Shpak <alex-shpak@users.noreply.github.com>
2020-05-22 10:35:31 +02:00
Alex Shpak
71e55e59d1 Set minimum version to 0.68 2020-05-17 13:18:34 +02:00
Alex Shpak
d5f55b4003
#220, Update 'BookEditPath' docs 2020-05-11 11:17:31 +02:00
Alex Shpak
9c5fc12dd8 Add build badge 2020-04-28 22:10:01 +02:00
Alex Shpak
9719692512 Introduce serviceWorker, disabled by default 2020-04-12 20:50:03 +02:00
Eugene van der Merwe
3011d3351d
Added Dark Mode to features (#184)
Updated the list of features.
2020-03-28 21:24:59 +01:00
Alex Shpak
a3059fe4f7 #140, Use new GetTerms function to fix tag titles 2020-03-19 22:00:45 +01:00
Alex Shpak
289a3f456e Add portable links, requires hugo 0.62 2020-03-07 18:47:16 +01:00
Alex Shpak
5d7f257e30 #150, Add content-before and content-after inject partials 2020-02-23 13:29:58 +01:00
Alex Shpak
cb61957623 Add scrollbar plugin and update README 2020-02-10 23:31:33 +01:00
Alex Shpak
c0bd5b5bb8 #90, Move inline scripts to file in assets to allow overwrite 2020-02-04 22:24:36 +01:00
Alex Shpak
dc7e2f0013 Update ToC docs in README 2020-01-24 00:36:26 +01:00
Alex Shpak
ba5d38ad44 Rework of main template, adds options for more fine customisation 2020-01-24 00:07:56 +01:00
Alex Shpak
4b641b0f9a #133, move disqus to separate template to allow override, rename BookDisqus to BookComments 2020-01-17 21:44:25 +01:00
Alex Shpak
ec53e2733f Update disqus support, add global site config BookDisqus 2020-01-13 17:55:34 +01:00
Dave Kerr
36a8cf5169 feat: added support for Disqus (#120)
* feat: added support for Disqus
* feat: allow disqus to be disabled through frontmatter

Set:
    bookDisableComments: true

On a page to disable disqus for the content.
2020-01-13 17:46:19 +01:00
Alex Shpak
e01674c287 Move baseof to _default folder, making it default view of site 2019-12-09 11:24:31 +01:00
Alex Shpak
a2e356d4bb
Update README.md 2019-12-01 19:31:27 +01:00
Alex Shpak
5af2b92f00 #106, Upgrade to hugo 0.60 2019-12-01 14:54:47 +01:00
Alex Shpak
681a6ed870 Set required version to 0.56 2019-11-29 22:58:20 +01:00
Alex Shpak
1e4d0001e2 Add multilingual mode to README 2019-11-16 21:48:35 +01:00
Alex Shpak
aaf236410e Update README.md 2019-11-16 20:35:23 +01:00
Alex Shpak
13584878c2 Polish multilang mode, update docs 2019-11-16 20:35:23 +01:00
Alex Shpak
a5788d71fa #80, Add search index configuration 2019-10-27 11:58:58 +01:00
Alex Shpak
4596f08e32 Rename ToC level styles, reorganize example content 2019-10-23 21:31:58 +02:00
Alex Shpak
e2188136e1 #51, Add experimental bookCollapseSection page param to hide nested sections 2019-10-09 01:00:40 +02:00
Alex Shpak
071e069d92 Update readme 2019-10-09 00:05:30 +02:00
Alex Shpak
00988ceee1 Remove BookMenuBundleActiveLinkColor parameter 2019-10-08 23:17:30 +02:00
Alex Shpak
007bc10c07 Introduce SCSS plugins: dark mode and numbered headings 2019-10-08 17:03:49 +02:00
Peiling Jiang
1cd5040d84 Add Google Analytics setup (in configuration file) hint. (#88) 2019-10-04 09:52:51 +02:00
Alex Shpak
1f8d34168f #77, Introduce hint shortcode 2019-10-03 18:15:24 +02:00
Alex Shpak
22ff783d86 #86, Add google analytics to readme, move GA and enable Open Graph in head 2019-10-03 14:10:03 +02:00
Olivier Beaulieu
ff6ba4b1ae Fixed typo in README 2019-09-30 11:03:10 +02:00