Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename HTML File in "docs/" Folder #49

Closed
3 tasks done
tajmone opened this issue Jan 15, 2020 · 0 comments
Closed
3 tasks done

Rename HTML File in "docs/" Folder #49

tajmone opened this issue Jan 15, 2020 · 0 comments
Labels
👑 HTML Issues with conversion to HTML format ⚠️ important Priority: High
Milestone

Comments

@tajmone
Copy link
Owner

tajmone commented Jan 15, 2020

In order for the build HTML book to be viewable on GitHub Pages it should be named index.hml. This requires some changes in the build toolchain.

  • Change docs_src/build.sh so that:
    • it builds the HTML doc in ../hugo-book.html (root folder).
    • Copies of ../hugo-book.html to docs/index.html.

The above will ensure that the root folder of the repo will contain both the AsciiDoc preprocessed version of the book as well as its HTML version properly named:

  • hugo-book.asciidoc
  • hugo-book.html

This is what most users will expect, so it justifies having a redundant copy of the HTML book in docs/, because the file named index.html is only useful for the website.

@tajmone tajmone added ⚠️ important Priority: High 👑 HTML Issues with conversion to HTML format labels Jan 15, 2020
@tajmone tajmone added this to the GitHub Pages milestone Jan 15, 2020
@tajmone tajmone mentioned this issue Jan 15, 2020
38 tasks
tajmone added a commit that referenced this issue Jan 28, 2020
Edit `docs_src/build.sh` so that it generates the HTML book in the repo
root, and then create a renamed copy as `docs/index.html` to be served
on the WWW via GitHub Pages. (closes #49)

* Update documents accordingly.
* Fix HTML Live links accordingly.
@tajmone tajmone closed this as completed Jan 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👑 HTML Issues with conversion to HTML format ⚠️ important Priority: High
Projects
None yet
Development

No branches or pull requests

1 participant