Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HTML comment to hide after line in README #114

Open
cxmeel opened this issue May 19, 2022 · 0 comments
Open

HTML comment to hide after line in README #114

cxmeel opened this issue May 19, 2022 · 0 comments
Labels
docusaurus plugin enhancement New feature or request

Comments

@cxmeel
Copy link

cxmeel commented May 19, 2022

Add the option to hide content in the README after a given line. This would ensure that only content between the <!--moonwave-hide-after-this-line--> and <!--moonwave-hide-before-this-line--> HTML comments is hidden.

While this might seem like a niche scenario, I prefer to use reference links in my markdown in project READMEs. This makes it easy to reuse a README with common links/images without having to adjust every reference to another project throughout the content.

Because moonwave hides all content before the HTML tag, including references, you end up with a README that looks like this:

image

Here's a partial raw README from Sift for reference:

<!-- Shields -->

[shields/github-release]: https://img.shields.io/github/v/release/csqrl/sift?label=latest+release&style=flat
[shields/wally]: https://img.shields.io/endpoint?url=https://runkit.io/clockworksquirrel/wally-version-shield/branches/master/csqrl/sift&color=blue&label=wally&style=flat
[shields/npm]: https://img.shields.io/npm/v/@rbxts/sift?style=flat

<!--moonwave-hide-after-this-line-->

# Sift

<!--moonwave-hide-before-this-line-->

<div align="center">

[![Source code][badges/github]][sift] [![NPM Package][badges/npm]][sift/npm] [![Itch.io store page][badges/itch]][sift/itch.io] [![Roblox library][badges/roblox]][sift/roblox]

[![Latest GitHub version][shields/github-release]][sift/releases] [![Latest Wally version][shields/wally]][sift/wally] [![Latest NPM version][shields/npm]][sift/npm]

</div>

Immutable data library for Luau and roblox-ts.
@cxmeel cxmeel changed the title HTML comment to hide *after* line in README HTML comment to hide after line in README May 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docusaurus plugin enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants