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

Move doc to index.org, generate index.html serve as GH pages. #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

brettviren
Copy link

Hi! Thanks for this refcard! I went looking for an online copy and couldn't find one. I think it is a good idea to serve a copy of the exported HTML as a GH page associated with your repository. I put a temporary copy online just to show the goal:

https://brettviren.github.io/refcard-org-mode/

project settings -> github pages -> source -> master / (root) -> save.

And, README.org content needs to move into index.org or otherwise arrange to generate to index.html.

README.org now only holds a few links and probably deserves some more spice. If you accept this PR, best then remove the link to my temporary online copy.

Some minor refcard content was modified:

  • Switched to online SETUPFILE. Maybe better to carry a copy of readtheorg?

  • I had problems related to id: and had to switch a reference to use the headline text.

  • Pointed UP and HOME to links related to the refcard served under "fniessen" namespaces.

… links.

This is meant to demo serving the refcard via GH pages.  The
README.org probably deserves more attention!

Content modified:

- Switched to online SETUPFILE.  Maybe better to carry a copy of readtheorg?

- I had problems related to id:<hash> and so switch a reference to use
  the headline text.

- Pointed UP and HOME to links related to the refcard.
@fniessen
Copy link
Owner

Dear @brettviren , thank you very much for this PR. Very interesting!

One response: Good you switched to the online SETUPFILE -- could be equally local, but this is better to avoid duplicates / out-of-date files.

Dunno why you had problems with ID... Any idea?

Finally, one question: do you know why the TOC is not expanding the nodes when you're scrolling down in the refcard? Locally, that does work...

Happy to merge soon, maybe when that last question would be answered.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants