問題タブ [readme]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
14 に答える
308127 参照

github - GitHub の README.md ファイルに色を追加する方法

README.mdプロジェクトunderscore-cliのファイルがあり、--colorフラグを文書化したいと考えています。

現在、これを行う唯一の方法は、スクリーンショットを使用することです (プロジェクト リポジトリに保存できます)。

たとえば .png

ただし、スクリーンショットはテキストではないため、読者はスクリーンショットのコマンドをコピーして貼り付けることができません。また、作成、編集、保守が面倒で、ブラウザーの読み込みが遅くなります。最新の Web では、レンダリングされた一連のテキスト イメージではなく、テキスト スタイルが使用されます。

一部の Markdown パーサーはインライン HTML スタイルをサポートしていますが、GitHub はサポートしていません。これは機能しません:

これは機能しません:

0 投票する
37 に答える
1552385 参照

github - GitHubのREADME.mdに画像を追加するにはどうすればよいですか?

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

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

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

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

0 投票する
4 に答える
6512 参照

github - GitHub の README.rst でイメージ (キャッシュ) を強制的に更新する方法

私のプロジェクトの 1 つで、外部画像リンクを使用して、GitHub ページを介してスクリーンショットを表示しています。これにより、README.rst が自動的に解析されます。

ROyWebのGitHubページ

このスクリーンショットをこの数週間で何度か Web サーバーで更新しましたが、GitHub ページで更新されていないことに気付きました...まあ、更新されていないと思います;-) GitHub はどういうわけか画像をダウンロードし、そこから読み込みますキャッシュ サーバー。

README.rst 内には、明らかに正しいリンクがあります。

ROyWeb スクリーンショットへの実際のリンク

生ファイルをロードすると、次のことを確認できます。

GitHub の生の README.txt

しかし、GitHubページで表示された画像のURLを確認すると、次のようになります。

GitHub にキャッシュされた ROyWeb のスクリーンショット

「再キャッシュ」を強制する方法を知っている人はいますか?

0 投票する
2 に答える
1364 参照

markdown - 自動リンクされた bitbucket readme マークダウンのリンクを解除する方法

BitBucket は MarkDown を使用して、リポジトリにある readme.md ファイルで「インデックス ページ」をレンダリングします。

readme.md ファイルにコミット ハッシュ 'a68c7c33f98668bea65636a7462a94f17446e151' のような文字列がありますが、そうではありません。

現在、bitbucket は urlize (django のプロジェクト) を使用して、readme.md 内の有用なすべてのものを自動リンクしているようです。

これはリンクには役立ちますが、コミットではないこのハッシュが存在しないコミットへのリンクになる場合はそうではありません。

ソースコードとしてマークせずにこのハッシュのリンクを解除する簡単な方法を探しています。

誰でもアイデアはありますか?

ありがとうございました!

0 投票する
0 に答える
442 参照

python - PyPI README.rst 形式の問題

私はPythonパッケージを持っています。README.rst説明を表示するファイルを追加しました。GitHubでは正常に表示されています

ただし、PyPIではRST ファイルがフォーマットされていません。生のコンテンツを表示しています。

setup.pyファイルはこちらにあります。誰かがこれについて私を助けることができますか?

0 投票する
0 に答える
160 参照

xcode - ターゲット フォルダー外でファイルを作成またはコピーする | Xcode 6 カスタム プロジェクト テンプレート

カスタム Xcode 6 プロジェクト テンプレートを作成しようとしています。Single View プロジェクトを使用してプロジェクトを作成するときの標準的なファイル レイアウトは次のようになります。

カスタム xcode テンプレートを使用して、このトップ レベルにファイルを追加するにはどうすればよいですか? .gitignore および README.md ファイルを追加したいので、次のようになります。

0 投票する
1 に答える
2088 参照

eclipse - Eclipse Luna でマークダウンのフォントの色を編集するにはどうすればよいですか?

Eclipse の暗い配色の場合、デフォルトのマークダウンの色は読みにくいです。これにより、たとえば README.md ファイルの編集が困難になります。

フォントの色を変更するための適切な設定を見つけるのにしばらく時間がかかり、その答えを共有したいと思いました.

0 投票する
1 に答える
988 参照

node.js - npmjs.com でパッケージの readme を管理するにはどうすればよいですか?

私は実際に npm パッケージを公開した経験が非常に限られているため、これはおそらく素人の質問です。パッケージの npmjs.com ページに掲載されている readme は、package.json で"readme"and/or"readmeFilename"フィールドを指定することで埋められているという印象を受けました。私は最近、これが実際には完全に間違っていることを知りました。これらのフィールドのいずれにも触れるべきではありません。

それを念頭に置いて、パッケージ ページに表示される内容を制御するにはどうすればよいでしょうか? README.md ファイルから自動的に抽出されますか? その場合、readme を変更してnpm publish再度実行すると、自動的に更新されますか? npm の Web サイトで使用されているマークダウン パーサーは何ですか?