jthegedus / jthegedus/docsify-select

Using docsify-select to do profiling for a whole page

Open
#9 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
30
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
We often have the issue that we need to maintain the same documentation for different target groups. The differences for them are minimal. We would like to maintain these differences once, and reuse the rest of the markdown text.

docsify-select is a plug-in that seems to offer this, but we'd have to duplicate the whole markdown text, and double maintain them.

Describe the solution you'd like
I'd like to be able to define the list box entries once for a complete markdown page, for example, "internal" and "default", and then be able to use a syntax in the markdown file to mark the beginning and the end of such sections, for example:

# Bake a cake

## What you need

1. Flour.
1. Sugar.
~~start:internal~~
1. Secret ingredient.
~~end:internal~~
1. Eggs.

For "default" all sections marked with start:**** / end:**** should be hidden.

Describe alternatives you've considered
I checked on docsify-mustache, but it seems it can only print out the values of variables, but cannot evaluate them to hide text snippets.

If you know if any alternatives to use profiling with docsify, it would be great if you could point me to them.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing docsify-select implementation and its documented selection behavior, then compare the referenced docsify-mustache alternative. Define how one page-wide list of profiles and the proposed start/end markers should be parsed, including the default view; done means marked sections render only for their selected profile without duplicating the surrounding markdown.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.