Coder Social home page Coder Social logo

Missing TOC about git-flight-rules HOT 8 CLOSED

k88hudson avatar k88hudson commented on May 13, 2024
Missing TOC

from git-flight-rules.

Comments (8)

k88hudson avatar k88hudson commented on May 13, 2024

Yeah, this is a good idea – I don't think I wan't to use a wiki, since it's kinda hidden, but some sort of table of contents is needed

from git-flight-rules.

freddyb avatar freddyb commented on May 13, 2024

Executing this

var z=""; for (var a of $$("a.anchor")) {  z+= "["+ a.nextSibling.textContent +"]("+a.href+")\n" }

in the console gives me:

[Flight rules for git](https://github.com/k88hudson/git-flight-rules#flight-rules-for-git)
[What are "flight rules"?](https://github.com/k88hudson/git-flight-rules#what-are-flight-rules)
[Conventions for this document](https://github.com/k88hudson/git-flight-rules#conventions-for-this-document)
[I need to add staged changes to the previous commit](https://github.com/k88hudson/git-flight-rules#i-need-to-add-staged-changes-to-the-previous-commit)
[I tried to push my amended commit to a remote, but I got an error message](https://github.com/k88hudson/git-flight-rules#i-tried-to-push-my-amended-commit-to-a-remote-but-i-got-an-error-message)
[I need to combine commits](https://github.com/k88hudson/git-flight-rules#i-need-to-combine-commits)
[Possible issues with interactive rebases](https://github.com/k88hudson/git-flight-rules#possible-issues-with-interactive-rebases)
[The rebase editing screen says 'noop'](https://github.com/k88hudson/git-flight-rules#the-rebase-editing-screen-says-noop)
[There were conflicts](https://github.com/k88hudson/git-flight-rules#there-were-conflicts)
[When I try to push, I get an error message:](https://github.com/k88hudson/git-flight-rules#when-i-try-to-push-i-get-an-error-message)
[I committed to master instead of a new branch](https://github.com/k88hudson/git-flight-rules#i-committed-to-master-instead-of-a-new-branch)
[I made several commits on a single branch that should be on different branches](https://github.com/k88hudson/git-flight-rules#i-made-several-commits-on-a-single-branch-that-should-be-on-different-branches)

Still needs sizes, or indentation if you want smaller/larger font size depending on h2/h3/h4

from git-flight-rules.

davidchall avatar davidchall commented on May 13, 2024

Or you could use DocumentUp: http://documentup.com/k88hudson/git-flight-rules

from git-flight-rules.

staabm avatar staabm commented on May 13, 2024

TOC could be done like on https://github.com/tiimgreen/github-cheat-sheet

Or you could use DocumentUp: http://documentup.com/k88hudson/git-flight-rules

this looks really awesome!! πŸ‘

from git-flight-rules.

mikejbrown avatar mikejbrown commented on May 13, 2024

πŸ‘ on DocumentUp

from git-flight-rules.

EHLOVader avatar EHLOVader commented on May 13, 2024

I recommend https://www.gitbook.io/ it would produce a more complete and professional document but would also require restructuring of this repo.

from git-flight-rules.

chendaniely avatar chendaniely commented on May 13, 2024

I stumbled over marked-toc goggling for the same problem.
it adds the toc to the document so it's view-able offline

from git-flight-rules.

RichardLitt avatar RichardLitt commented on May 13, 2024

Using Doctoc, seems to work.

from git-flight-rules.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.