问题标签 [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 投票
1 回答
582 浏览

github - Github UI - 在预览窗格中查看后无法进一步编辑文件

我想使用 Github 编辑/预览文件界面创建一个 README.md 文件。问题是当我切换到预览窗格然后返回编辑窗格时,我可以看到一个光标在文档的最顶部闪烁,但无法移动它或执行任何进一步的编辑。

如果我想添加/修改内容,我需要取消整个操作并从头开始。不用说,这不是最优的。我在这里缺少什么吗?还是根本不可能?任何指针都非常感谢。

0 投票
2 回答
3820 浏览

github-pages - README.md 在 github 页面中显示为索引文件 [hugo 博客引擎部署]

*在将帖子渲染为github中托管的静态页面时提出问题......我愿意完成的是与Hugo的个人博客环境!到目前为止,我已经在本地运行该站点并且运行良好......但是在 Github 中部署时,我访问该站点时唯一得到的是

块引用

README.md 呈现为索引页面:https ://passager07.github.io/ 我没有访问...content/post/[post].md

块引用

https://github.com/passager07/passager07.github.io

0 投票
1 回答
3460 浏览

visual-studio-code - 在 README.md 中插入视频以获得 vscode 的扩展

我有一个 .mp4 格式的视频,我想将它插入 README.md 以扩展 vscode。

0 投票
2 回答
7571 浏览

sonarqube - 在 Gitlab README.md 中为 SonarQube 徽章使用 Gitlab 变量

我正在使用 Gitlab 和 Sonarqube 以及Sonarqube Plugin SVG Badges
为了在 gitlab 上表示 Sonarqube 状态,我的README.md文件中有这样的内容:

这很完美。显示了我的徽章,链接正常,一切都很好。

有没有办法构建类似的东西:

我想提供一个骨架,每个开发人员都可以将其复制并粘贴到他们的README.md文件中,并且变量会自动填充到自述文件中,例如.gitlab-ci.yml

我还尝试了这里提到的永久 Gitlab 变量,但这也不起作用!

有人有什么想法吗?

0 投票
1 回答
139 浏览

doxygen - 两个 README 文件,Doxygen 挑错了一个

项目结构:

Doxyfile1用于内部文档,Doxyfile2如果用于最终用户文档。
Doxyfile1记录整个项目,仅Doxyfile2记录文件Subdir

在最终用户文档中,我正确地得到了Subdir/README.md显示的文件。在内部文档中,我仍然得到相同的Subdir/README.md文件,而不是README.md.

在 Doxyfiles 中,我明确指定了README.md文件的路径,无论是在USE_MDFILE_AS_MAINPAGE字段中还是在INPUT字段中。

为什么Doxyfile1总是指向错误的README.md文件?

会不会是README.md项目中需要一个文件,所以随机选择了一个文件?

0 投票
0 回答
972 浏览

jupyter-notebook - 是否可以像在 GitHub 上一样在 Jupyter 仪表板上将 README 文件显示为降价?

我尝试将 README 文件 (.md) 放在 Jupyter 仪表板上,就像我在 GitHub 上将其显示为降价单元格一样(它显示内容而无需专门打开文件)。有谁知道这是否可能?还是只能在 GitHub 上实现?

谢谢!

0 投票
2 回答
6628 浏览

audio - 在 Github readme.md 中添加音频

有没有办法在 Github readme.md 中添加音频条?我希望能够直接通过 readme.md 播放某个 mp3 文件,而不是被定向到一些 soundcloud 或 youtube 链接。

0 投票
0 回答
21 浏览

npm - 手动触发 NPM 重新缓存自述文件?

有谁知道如何指示 NPM 重新缓存给定包的自述文件?

我刚刚重新发布到 npm 几次,但现在已经过时的自述文件没有更新,我不明白为什么。

0 投票
0 回答
812 浏览

github - 在 README 中调整 gif 演示的大小

我有两个 GIF,我想在我的 README 中并排放置。

![Demo](https://user-images.githubusercontent.com/14092539/27794834-cc32c936-5fd1-11e7-9c37-f2dc5cabe32d.gif)

![Demo](https://user-images.githubusercontent.com/14092539/27794978-4fe9c2c0-5fd2-11e7-8a96-28d72fa103d1.gif)

我试图通过在地址末尾粘贴 =250x250 来调整它们的大小,但这没有用。有什么建议么?

0 投票
0 回答
193 浏览

php - WordPress 插件:readme.txt 不被 WordPress 读取

我目前正在开发一个私有 WordPress 插件,使用BoilerPlate作为基础,使用Plugin-update-checker进行自动更新(我的插件不在官方 WordPress 存储库中)。

现在,我有一个问题:WordPress 不读取我的README.txt,当我想要进行更新时,它应该给我我的 readme.txt 的更改日志部分。它应该给我这个:

问题是,这个readme.txt和更新plugin-update-checker在我的其他插件上完美运行,所以我现在真的迷路了。

这是我的插件的标题:

如果您需要更多信息,请告诉我,对不起我的英语,谢谢。