開発者として、私はドキュメントを書くのが本当に好きではありませんが、そうしなければならないときは、プロセスをできるだけ簡単にしたいと思っています。

Word の問題は、常に私の邪魔になることです。中身よりもレイアウトが気になる…だからワードはやめたい。

理想的には、自分のコンテンツを書き、それをドキュメントに「コンパイル」したいと考えています。

LaTeXのことは聞いたことがありますが、まったく経験がありません。これは、この仕事に適したテクノロジーでしょうか? どのエディター (Windows) を使用すればよいですか? LyXから始めるのは良い考えですか?

編集: コードの文書化について質問しているわけではありません (そのために Sandcastle を使用しています)。

更新 2014:

現在、 GFM (GitHub Flavored Markdown)に切り替えています。

• 操作はとても簡単です。
• 同じ IDE でコードとドキュメントを作成してください!
• すべてをバージョン管理できます！
• raw txt、html、またはpdfのいずれかとして優れた出力を取得します。

<a>Markdown ファイル内から、同じリポジトリおよびブランチ内の別のファイルへの URL アンカー リンク (別名、現在のブランチへの相対リンク) を作成する方法はありますか?

たとえば、master ブランチには README.md ファイルがあり、次のようにしたいと考えています。

これにより、同じブランチ内である .md から別の .md にリンクすることができ、自分がどのブランチにいるのかを気にする必要がなくなります (github.com ブランチ名を含む絶対 URL を実行する必要がなくなります)。

これが私が意味することの実例です：

1. GOTO http://github.com/rynop/testRel、リンクが機能しません。
2. GOTO http://github.com/rynop/testRel/blob/master/README.md、リンクが機能します。

これは、この時点で開始 URL がブランチにあるためです。リポジトリのルートにある README.md の現在のブランチを取得するにはどうすればよいですか?

更新:この機能のリクエストについて、GitHub に対してイシューを開きました。

GitHub フレーバーの Markdownファイルを取得して HTML にレンダリングするためのコマンド ライン ユーティリティがあるかどうか疑問に思っています。

GitHub wiki を使用して Web サイトのコンテンツを作成しています。サーバー上のリポジトリを複製した後、それを通常の HTML に処理したいと考えています。GitHub に表示されるものが、まさに私の Web サイトでどのように表示されるかが重要です。また、フェンスで囲まれたブロックを~~~で使用したいので、標準の Markdown 構文のみを使用したくありません。

Node.js にフックできると思って、JavaScript のライブ プレビューを少し調べましたが、非推奨であるとのことです。redcarpet リポジトリを確認しましたが、コマンド ライン インターフェイスがないようです。

私は独自のソリューションを作成しましたが、他のソリューションより明らかに優れているソリューションはないため、回答を選択せず​​に質問を残します。

githubプロジェクトのreadmeを.md形式で書いています。githubにコミットする前に、readme.mdファイルがどのようになるかをテストする方法はありますか？

私たちのサイト (非常に非技術的な人々を対象としています) では、メールを送信するときに Markdown を使用できるようにしています。そうすれば、太字やイタリック体などの素敵なものが得られます。ただし、非技術的であるため、「改行を実際に機能させるために2行追加する」という癖を乗り越えることはできません.

その主な理由として、Github Flavored Markdownのバリアントを使用しています。

主にこの部分をお借りしました：

これはうまく機能しますが、場合によっては改行が追加されません。その鍵は、そのコメントの「非常に明確な場合」の部分にあると思います。

私が正しく解釈すると、これは、単語文字または「<」で始まる行に改行を追加するだけです。

それがなぜなのか誰か知っていますか？特に、なぜ「<」なのか?

本質的に何か (スペース、ハイフンなどで始まる行) に 2 つのスペースを追加するだけで何が害になるでしょうか?

README.mdGitHub でホストされているプロジェクトを記述するために使用するマークダウン ファイルがあります。このファイル内には、通常のマークダウンと同様に、それぞれが 1 つ以上のハッシュで始まるいくつかの見出しとサブ見出しがあります。

ここで、ある見出しのテキストを に設定したいのですC#が、GitHub はテキストの一部のハッシュを尊重せず、見出しの (オプションの) 終了ハッシュとして解釈します。

バックスラッシュを前に付けてハッシュをエスケープしても機能しません。だから私がタイプすると

私は得る：

私が使用する場合

私は得る：

この見出しを正しく書くにはどうすればよいですか?

画像付きの JavaScript ブックマークレットを github の readme に追加するのに問題があります。この画像は、ユーザーがブックマークをブックマーク バーに簡単に追加できるようにするためのものです。

基本的に、これ (http://alaingilbert.github.com/Turntable-API/bookmarklet.html)は私が達成しようとしているものですが、代わりに github readme にあります。

これまでのところ、私はこれを持っています：

しかし、github で私の readme のソースコードを見ると、href 属性がなくなっているように見えるため、ブックマークレットが機能しなくなっていることに気付きました。

github は javascript の href を自動的に削除しますか? この問題を解決する方法はありますか?

編集: table、tbody、tr、および td タグの属性も削除されているようです。github が気に入らないようですか?

最近GitHubに参加しました。私はそこでいくつかのプロジェクトを主催しました。

READMEファイルにいくつかの画像を含める必要があります。どうすればいいのかわかりません。

これについて検索しましたが、「Webで画像をホストし、README.mdファイルで画像パスを指定する」というリンクしかありませんでした。

サードパーティのウェブホスティングサービスで画像をホストせずにこれを行う方法はありますか？

githubのマークダウンでカスタムフォントを使用することは可能ですか？現在、画像をロゴとして読み込んでいますが、フォントのレンダリングはより高速で優れています。

私はJekyllを使用してブログを運営しており、GitHub で開発および使用されているRedcarpet マークダウンインタープリターで解決すると考えました。

たまたまバグに遭遇し、問題をチェックアウトしたところ、これが見つかりました。

メンテナは、「お気づきかもしれませんが (har har har har) Redcarpet をメンテナンスする時間がもうありません。それは私にとって優先事項ではなく (Markdown は完全に退屈だと思います)、GitHub にとっても優先事項ではありません。本番環境で使用する時間が長くなります。」

そう...

1. Jekyll (および pygments) で使用できる優れた Ruby マークダウン インタープリター (つまり、適切な構文で積極的に開発されているもの) はありますか?

2. さらに良いことに、GitHub Flavored Markdown に似た (または少なくとも近い) 構文を持つマークダウン インタープリターはありますか?