Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Encapsulating Docsify

Offen
  • Stimmt etwas nicht?
#2,135 6 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 8 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
javascript
Bereich
frontend, web-dev

Rechercherichtung

Beginne damit, die in #2104 referenzierte Checkliste zur Kapselung und die zugehörigen Klassenänderungen zu lesen. Erfasse die Anforderungen an Fortschrittsbalken, Routing und den Zustand auf Modulebene und definiere anschließend die Fertigstellung als Unterstützung einer konfigurierbaren Platzierung des Fortschrittsbalkens, eines optionalen virtuellen und extern gesteuerten Routings sowie eines Zustands pro Instanz, ohne die Standardwerte zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

We need allow the ability to fully encapsulate Docsify features and state.

With encapsulation, it will be possible later on to mount any number of Docsify instances anywhere in a web site, as well as become possible to wrap Docsify as a React/Vue/Svelte/etc component that can be used in any framework.

Encapsulation changes:

  • progress bar currently appends to body. There should be an option to provide the location where it should be appended. It can default to body for backwards compatibility.
  • Routing: it currently assumes control of the address bar. For backwards compatibility, this can be the default.
    • We need an option to make it route virtually, without touching the address bar, for cases when that is desirable
    • Perhaps add the ability to listen to a Docsify instance's route changes, so that they can be mapped to the address bar in a custom way. Also allow setting Docsify's route from outside, so that a website managing multiple instances can "paginate" Docsify manually.
  • Some Docsify state is at the module level (singleton), including the aforementioned progress bar, but also including state variables. We should bring state into the Docsify class. Some of this this in #2104 in the items where we're bringing some functions into the classes as private methods.
Vorherrschende Sprache
JavaScript
Sterne
31.5k
Forks
5.8k
Ø Merge
7 T. 18 Std.
Gemergte PRs (30 T.)
9

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus docsifyjs/docsify

Alle Issues in docsifyjs/docsify

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.