1

Several months ago I start to write down my guidelines at github:

https://github.com/guettli/programming-guidelines

The lists get longer and now I would like to improve the structure.

I guess it is time to switch from README.md to a other solution.

My goals:

  • use git to do version control
  • editable via web (SaaS). No native application should be needed.
  • automated numbered headings. Up to now I am numbering the headings by hand
  • splitting the long single page into several smaller pages
  • I like mark-down and would like to stick to it
  • Commercial services are fine.

Which software could help me?

  • Which OS should it run on? And I assume it should be gratis? – Izzy Jan 18 at 12:53
  • Hi Izzy, thank you for asking. I updated the question. – guettli Jan 18 at 22:02
  • You could use markdown with a CSS style sheet for the numbering, or a markdown to latex converter. Links or imports would work for the smaller pages. Is that the kind of structure improvement you’re looking for? – Émile Jetzer Jan 18 at 22:55
  • 1
    Thanks for the update! Just to make sure: you're looking for a "SaaS" (probably web-based) editor to manage Readme files in git repos, like they are used in/supported by Github, GitLab, Gitea etc. making it easier to edit those in a format supported by mentioned services, so they display them properly? – Izzy Jan 19 at 1:18
  • 1
    Markdown itself is note the best format. Take a look at .asciidoctor and/or org-mode. github supports both. – y_ug Jan 21 at 17:28
4

You, sir, are looking for GitHub Wikis.

| improve this answer | |
  • I must have been blind. This looks like a solid solution. Thank you! – guettli Jan 21 at 7:17
  • @guettli I'm glad to help. If this is an adequate solution, could you mark the answer as accepted? I just joined this exchange and I'd love the rep. – William Rosenbloom Jan 21 at 20:33

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.