Git and Documentation

When you try to merge a .docx with git, it isint always beautiful.

It get even worst if you try to merge an image or some PDF documents.

  • In what version of Git did git-status get the --branch option?
  • Is there a way to get colored text in Github Flavored Markdown?
  • Where is the '-c' config flag documented for git?
  • Why isn't a conceptual Git article out there without any piece of console juggling?
  • Generating API documents in Git Workflow
  • Getting started with hg quickly for a git user
  • I had a few ideas such as:

    1. one person working on one document at the time and then pushing immediatly,
    2. always pull before pushing and see what other peoples changed then merge manually and push
    3. not using git for documentation

    So my question is, how do you manage your documentation with git?

  • how to get git log display name of (deleted) branches
  • Git: temporarily reverting pushed commit(s)
  • How do I .ignore files with Git GUI?
  • How to undo a successful “git cherry-pick”?
  • Merging diff between two git branches and applying it to working copy
  • Is it possible to open GitHub code in Plunker?
  • 4 Solutions collect form web for “Git and Documentation”

    Simple — for documentation, use a plain text format, which is what git is built for. You could use LaTeX, Sphinx, Markdown, or any other number of things. Messy XML formats like .docx will not merge well.

    I use a textual format, like Docbook or TeX or HTML or (gasp) text for my documentation.

    Docbook in particular generates lots of output formats (HTML, PDF, etc) and is a great standardized way of writing documentation.

    You can also use external synchronization to pass virtual updating tokens. We coordinate on irc or mail when we have to do stuff that might conflict.

    You can follow the example of Git project: they wrote the user manual in AsciiDoc.

    The unhelpful answer is: Don’t try to do such merges. Use an external diff tool that is suitable for the problem format. Or, as other has said, use a format that is amenable to having a plain old merge that won’t cause grief.

    Git Baby is a git and github fan, let's start git clone.