docsify this
v1.9.16: Merge pull request #161 from hibbitts-design
Cette application Web open source, conçue avec le générateur de sites de documentation magique Docsify, vous permet de publier des fichiers de marque en ligne sous forme de pages Web sans configurer votre propre site Web.
Consultez ce que Docsify-This peut faire en affichant ce fichier ReadMe en tant que page Web avec une barre latérale en option qui comprend des titres jusqu'à 4 niveaux!
Figure 1. Builder de page Web Docsify-This.NET.
Avez-vous essayé Docsify-This? Partagez vos commentaires sur Docsify-This
Docsify-This fournit un moyen facile d'afficher et de partager le contenu Markdown dans divers contextes, sans le processus de configuration ni de création de site Web requis. En hébergeant vos fichiers Markdown sur GitHub ou Codeberg, vous pouvez également tirer parti du contrôle de la version (la possibilité de suivre et d'inverser les modifications) et d'activer la collaboration.
Avec docsify-this vous pouvez:
Docsify-Il s'agit d'un site de kit de démarrage de publication de publication ouverte sur mesure configuré pour rendre les fichiers de marque distante via des paramètres d'URL dans le format suivant:
https://docsify-this.net?basePath=URLpath&homepage=filename.md
Le paramètre DocSify BasEpath est le chemin d'accès URL contenant le fichier de marque de source brut à rendre. Si le fichier est nommé, Readme.md par défaut attendu, aucun autre paramètre n'est requis, sinon le paramètre DoTSify de page d'accueil doit également être inclus défini sur le nom du fichier à rendre. Un exemple de docsify-cette URL serait: https://docsify-this.net/?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-one-page-article/main&homepage=home.md
Docsify-cela peut rendre des fichiers de partout où le contenu d'un fichier Markdown peut être affiché dans un navigateur Web, notamment:
Pour rendre directement un fichier stocké dans un référentiel GitHub public lorsque vous n'utilisez pas le constructeur de page Web ci-dessus, vous devez utiliser l'URL de source brute de ce fichier (c'est-à-dire RAW.githubuserContent.com) en appuyant sur le bouton brut lors de la visualisation d'un fichier. Il est également possible de rendre un fichier stocké dans un référentiel GitHub privé en activant les pages GitHub dans ce référentiel, puis en utilisant l'URL des pages GitHub de ce fichier (c'est-à-dire username.github.io).
L'apparition des fichiers de marque rendus peut être personnalisée par des paramètres d'URL en option et un petit ensemble de classes CSS disponibles dans les fichiers de marque source. En plus de supporter la marque standard, les diagrammes intégrés, H5P, Latex et Sirène sont inclus. Facultativement, l'annotation de la page avec des hypothèses peut être activée.
Vous cherchez une introduction globale à la publication avec Docsify-This? Consultez la publication de Markdown avec Docsify-This.
Je suis époustouflé uniquement par le fait que vous mettez une URL (fichier de marque) dans Docsify-This et ensuite vous obtenez une URL pour une page Web… terminée! Prenez l'URL et allez. C'est tellement transparent.
- J. Groom, Reclaim Today Episode 39 (co-fondateur, Reclaim Hosting)
J'ai utilisé Docsify-This pour mon cours de production d'édition de diplômés, en partie pour explorer de nouveaux modèles dans Markdown Publishing, mais en partie aussi pour apprivoiser Canvas, que je trouve maladroit et encombrant. Garder toutes mes notes de cours en tant que fichiers en texte brut et les déployer via GitHub et Docsify - c'est facile et rend mon développement un jeu de cours. De plus, je garde tous mes matériaux localement et je peux utiliser les réutiliser sans dépendre de toile.
- J. Maxwell (directeur et professeur agrégé dans le programme d'édition de l'Université Simon Fraser)
Meilleur outil que j'ai trouvé depuis des années - c'est l'une de ces créations qui est juste bien fait, jusqu'au cœur.
- D. Malawey (coordinateur de laboratoire multidisciplinaire, Texas A&M University)
Docsify-cela a considérablement amélioré mes thèmes WordPress en étant en mesure de s'intégrer de manière transparente dans l'interface la même documentation que j'utilise dans le référentiel GitHub. Cela m'a conduit à écrire de meilleurs documents! J'ai à peine gratté la surface de ce que Docsify - cela peut faire en tant qu'outil de publication Web simple à utiliser.
- A. Levine alias Cogdog (technologue éducatif indépendant)
Docsify-This a été reconnu comme finaliste dans la catégorie des infrastructures ouvertes pour les Awards pour l'excellence de l'éducation ouverte de 2024 - merci à tous les agents et contributeurs docsify.js.org, et aux autres éditeurs ouverts, éducateurs et créateurs qui partagent leur contenu ouvert avec le reste du monde par le biais de Docsify-This.
L'apparition visuelle d'un fichier de démarrage en ligne affiché sous forme de page Web par docsify - cela peut être modifié de deux manières:
Par exemple, pour afficher le fichier Markdown situé à https://raw.githubusercontent.com/hibbitts-design/docsify-this-one-page-article/main/home.md avec une barre latérale docsify, y compris des en-têtes jusqu'à 3 niveaux, le document de docyfy-this est:
https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-one-page-article/main&homepage=home.md&sidebar=true&maxLevel=3Et voici comment docsify-this.net affiche la même URL:
La page Web affichée par Docsify-This.net, affichant le fichier Markdown avec une barre latérale qui inclut des titres jusqu'à 3 niveaux, comme spécifié par l'URL docsify-cette URL.
En savoir plus sur chacun des paramètres de base DocSify-This URL ci-dessous et découvrez ce qui est possible lors de la combinaison des paramètres d'URL et des fichiers de démarrage en ligne avec un ensemble de modèles de docsify-docsify-usage-ces modèles.
Paramètres URL de base (inclus dans le constructeur de pages Web standard)
Définissez un titre personnalisé sur l'onglet du navigateur pour vos pages Web avec le paramètre de navigateur de navigateur en option, par exemple: par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/paulhibbitts/demo-grav-open-matter-course-hub/master/pages/04.resources&homepage=page.md&browser-tab-itle=Resources s'il vous plaît noter à utiliser les titres avec des spaces they-odest, Page "serait" mon% 20page ".
Affichez un lien "Modifier cette page" (l'emplacement par défaut est en bas de la page) avec le paramètre Edit-Link facultatif, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starte r-kit / main & editLink = https: //github.com/hibbitts-design/docsify-open-publishing-starter-kit/blob/main/readme.md
Modifiez le texte par défaut pour un lien "Modifier cette page" avec le paramètre Modifier le texte Edit-Link , par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main&edit-li nk = https: //github.com/hibbitts-design/docsify-open-publishing-starter-kit/blob/main/readme.md&edit-ink-text=view%20as%20markdown Veuillez noter pour utiliser du texte avec des espaces, ils doivent être codés, donc "Voir comme Markdown" serait "Voir% 20As% 20Markdown".
Modifiez l'emplacement du lien "Modifier cette page" du bas des pages pour être le haut des pages avec le paramètre Edit-Link en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main&toc = true & editLink = https: //github.com/hibbitts-design/docsify-open-publishing-starter-kit/blob/main/readme.md&edit-ink-top=true
Définissez une police personnalisée pour vos pages Web avec le paramètre Font-Family en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&font-family=helvetea,aralsans-sans-serif. Ce paramètre peut être particulièrement précieux lorsque vous essayez de mieux correspondre à la présentation visuelle du contenu intégré avec votre plate-forme de destination. Veuillez noter pour utiliser des polices avec des espaces dans leur nom, ils doivent être encodés, donc "Courier New" serait "Courier% 20New".
Définissez une taille de police personnalisée pour vos pages Web avec le paramètre de taille de police en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&font-size=1. Ce paramètre peut être particulièrement précieux lorsque vous essayez de mieux correspondre à la présentation visuelle du contenu intégré avec votre plate-forme de destination. Veuillez noter que la taille de la police est définie dans les unités REM.
Définissez un poids de police en en-tête personnalisé (par défaut est 400 - régulièrement) pour vos pages Web avec le paramètre en tête-poids en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&header-weight=600.
Masquer les crédits habituellement affichés en bas de chaque page Docsify-cette page avec le paramètre Hide-Credits facultatif, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&hide-crets=true.
Activer l'annotation de la page avec des hypothèses. Est avec le paramètre d'hypothèse facultatif, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-courson-tarter-kit/main/docs&homepage=resources.md&hypothesis=true.
Définissez une hauteur de ligne personnalisée pour vos pages Web avec le paramètre de hauteur de ligne en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&line-height=1.5.
Définissez une couleur personnalisée pour tous les liens, définis à l'aide du format hexadécimal standard sans le symbole '#' avec le paramètre de couleur lien facultatif, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&link-color=cc0000.
Définissez le niveau d'en-tête maximal de la barre latérale Docsify avec le paramètre MAXLEVEL DOCSIFIE en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=introduction.md&idebar=True&Maxlevel=33
Affichez une barre latérale DOCSIFY avec le paramètre de barre latérale en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main&idebar=true
Affichez une table des contenus avec le paramètre TOC en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=introduction.md&toc=true
Définissez les niveaux d'en-tête de page (c'est-à-dire H1, H2, etc.) pour être inclus dans la table des contenus avec le paramètre en option des toc , par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=introduction.md&toc=true&toc-headings=h1 ,h2 ,h3.
Utilisez une table des contenus moins large avec le paramètre TOC-NARROW en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=introduction.md&toc-narrow=True. Ce paramètre peut être particulièrement précieux lors de l'intégration du contenu où une zone d'écran plus petite est probable.
Activer l'image zoom (tapping sur les images de la page pour les élargir) avec le paramètre de docsify zoom-iMages en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/paulhibbitts/docsify-this-markdown-content-demo/main&zoom-images=true. Pour exclure les images, utilisez  .
Les paramètres d'URL supplémentaires suivants sont disponibles pour une utilisation dans les URL docsify-cette URL et sont inclus dans le constructeur de page Web avancé, sauf indication contraire.
Paramètres d'URL supplémentaires (inclus dans le constructeur avancé de page Web)
Affichez une page de couverture personnalisée DOCSIFE avec le paramètre de couverture en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=home.md&cverpage=_coverpage.md
Définissez une couleur personnalisée pour la page de couverture avec le paramètre de couleur de couverture en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=home.md&coverpage=_coverpage.md&coverpage-color=cc000000
Définissez une couleur personnalisée pour la page de couverture en mode sombre avec le paramètre en mode COPPAGE COPAGE-COLOR-DARK , par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=home .md & dark-mode = true & link-color = cc0000 & link-color-dark-mode = ff9e9e & couverpage = _Coverpage.md & CoverPage-Color = CC0000 & CoverPage-Color-Dark-Mode = 4d0000
Communiquez automatiquement le thème clair / sombre en fonction de la préférence au niveau du système d'exploitation système, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=introduction.md&dark-mode=true
Modifiez l'emoji par défaut pour un lien "Modifier cette page" avec le paramètre Edit-Link-Emoji en option (non inclus dans le constructeur de page Web avancé), par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main&edit-link=https://git hub.com/hibbitts-design/docsify-open-publishing-starter-kit/blob/main/readme.md&edit-link-text=view%20on%20github&edit-link-emoji=:file_folder:
Activez le chargement paresseux des images par les navigateurs avec le paramètre facultatif des images de chargement paresseux (non inclus dans le constructeur de page Web avancé), par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=introduction.md&lazy-load-images=True Exemple par la barre latérale Docsify, etc.
Définissez une couleur personnalisée pour tous les liens en mode sombre, défini à l'aide du format hexadécimal standard sans le symbole '#' avec le paramètre en mode Color-Dark en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&link-color=ff0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000.
Définissez une couleur de surtension personnalisée pour tous les liens, définie à l'aide du format hexadécimal standard sans le symbole '#' avec le paramètre en option du link-hover-coulor , par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&link-hover-color=cc000000.
Définissez une couleur de voltige personnalisée pour tous les liens en mode sombre, défini à l'aide du format hexadécimal standard sans le symbole '#' avec le paramètre en mode link-hover-color-dark , par exemple: par exemple: par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-ta rter-kit / main / docs & homepage = Resources.md & link-color = cc0000 & dark-mode = true & link-hover-color-dark-mode = ff9e9e.
Définissez une décoration de texte personnalisée pour tous les liens, avec le paramètre en option de liaison-texte-décoration , par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&link-text-decoration=none
Définissez une décoration de texte de survie personnalisée pour tous les liens, avec le paramètre en option de liaison-texte-décoration , par exemple: par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-course-starter-kit/main/docs&homepage=resources.md&link-text-decoration-hover=undline=
Vous pouvez définir un favicon personnalisé à partir du fichier image passé à partir du paramètre LoadFavicon en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/paulhibbitts/docsify-this-markdown-content-demo/main&loadfavicon=open-access.png
Chargez un pied de page Docsify à partir du fichier Markdown dans le répertoire actuel passé avec le paramètre DoCSify LoadFooter en option, par exemple: https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=introduction.md&loadfooter=_footer.md
Chargez une barre de navigation personnalisée DOCSIFY à partir du fichier Markdown passé avec le paramètre DocSify LoadNavbar en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-open-publishing-starter-kit/main/docs&homepage=introduction.md&loadnavar=_navbar.md.
Chargez une barre latérale personnalisée DOCSIFY à partir du fichier Markdown passé avec le paramètre DocSify en option de chargement de chargement , par exemple:
https://docsify-this.net/?basepath=https://raw.githubusercontent.com/paulhibbitts/docsify-this-cmpt-363-222-site/main&homepage=home.md&idebar=true&oladebar=_sidebar-with-home.md
Affichez une image de logo pour le site Web dans une barre latérale personnalisée DOCSIFY (IE Fichier 'Logo.png) avec le paramètre Docsify Logo Facultatif, par exemple:
https://docsify-this.net/?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-course- Site / Main & HomePage = home.md & sidebar = true & loshsidebar = _sidebar.md & loadnavbar = _navbar.md & name = cpt-363 & logo = / images / logo.png Le chemin du dossier complet et le nom de fichier doivent être fournis. Un nom de site Web doit également être fourni et sera utilisé comme texte ALT pour le logo.
Fusionnez les éléments Navbar en haut de la barre latérale sur des écrans plus petits avec le paramètre Mergenavbar en option, par exemple: par exemple: https://docsify-this.net/?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-ures e-site / main & homepage = home.md & sidebar = true & loadsidebar = _sidebar.md & loadnavbar = _navbar.md & mergenavbar = true & name = cpt-363
Affichez le nom du site Web dans une barre latérale personnalisée DOCSIFY (IE Fichier '_sidebar.md) avec le paramètre DocSify Nom DocSify facultatif, par exemple:
https://docsify-this.net/?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-co ursite-site / main & homepage = home.md & sidebar = true & loadsidebar = _sidebar.md & loadnavbar = _navbar.md & search = true & name = cpt-363 Lorsque ce paramètre est fourni, il sera également utilisé automatiquement comme titre de l'onglet du navigateur.
Définissez un titre de page personnalisé en haut de vos pages Web avec le paramètre de titre de page en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/paulhibbitts/demo-grav-open-matter-course-hub/master/pages/04.resources&homepage=page.md&page-title=Resources s'il vous plaît noter à utiliser des titres avec les spaces qu'ils doivent être codé "Mon% 20page".
Afficher les boutons de pagination dans la zone de contenu de la page (barre latérale personnalisée requise) avec le paramètre de pagination en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-cour SE-site / main & homepage = home.md & sidebar = true & loadsidebar = _sidebar.md & loadnavbar = _navbar.md & search = true & pagination = true =
Activez le plugin de recherche DocSify (qui comprend actuellement des correspondances pour le texte et le balisage) sur plusieurs sites de pages, y compris une barre latérale personnalisée avec le paramètre DoCSify de recherche en option, par exemple:
https://docsify-this.net?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-pag E-Course Site / Main & Homepage = Home.md & Sidebar = True & LoadsideBar = _sidebar.md & Loadnavbar = _navbar.md & SearchBox = true =
Définissez la table des matières maximale des niveaux d'en-tête dans la barre latérale personnalisée DOCSIFY (IE Fichier '_sidebar.md) avec le paramètre DoCSify de sous-maternelle en option, par exemple:
https://docsify-this.net/?basepath=https://raw.githubusercontent.com/paulhibbitts/docsify-this-cmpt-363-222-site/main&homepage=home.md&sidebar=true&oladebar=_sidebar-with-home.md&sibar=131
Utilisez la version SVG des icônes impressionnantes de Font au lieu de polices Web avec le paramètre SVG-ICONS en option (non inclus dans le constructeur de page Web avancé), par exemple:
https://v2.preview.docsify-this.net/?basepath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-lms-content-pages/main&homepage=schedule.md&svg-icons=true
Intégrer du contenu dans la toile
Exemple de code IFRAME, y compris les paramètres d'URL pour faire correspondre de manière transparente docsify-ce contenu sur canvas:
< p > < iframe style =" overflow: hidden; border: 0px #ffffff none; background: #ffffff; " src =" https://docsify-this.net?basePath=https://raw.githubusercontent.com/paulhibbitts/cmpt-363-222-pages/main&homepage=home.md&font-family=Lato%20Extended,Lato,Helvetica%20Neue,Helvetica,Arial,sans-serif&font-size=1&hide-credits=true " width =" 800px " height =" 1400px " allowfullscreen =" allowfullscreen " > </ iframe > </ p >Si une barre de défilement est présente, vous voudrez peut-être rééditer votre code IFRAME et ajuster la valeur "hauteur".
Comment ajouter une URL externe comme élément de module?
Exemple de lien externe du module, avec table des contenus:
https://docsify-this.net?basePath=https://raw.githubusercontent.com/paulhibbitts/cmpt-363/main/docs/222&homepage=week-02.md&toc-narrow=true&font-family=Lato%20Extended,Lato,Helvetica%20Neue,Helvetica,Arial,sans-serif&font-size=1&hide-credits=true Création d'un lien personnalisé dans votre navigation de cours à l'aide de l'outil de redirection
Exemple de champ URL de redirection:
https://docsify-this.net/?basePath=https://raw.githubusercontent.com/paulhibbitts/cmpt-363-222-pages/main&homepage=resources.md&edit-link=https://github.com/paulhibbitts/cmpt-363-222-pages/blob/main/resources.md&font-family=Lato%20Extended,Lato,Helvetica%20Neue,Helvetica,Arial,sans-serif&font-size=1&hide-credits=trueiframe (pour intégrer du contenu dans les pages)
Outil externe (pour ajouter un lien à la navigation de cours ou aux éléments)
Bien que tout ce dont vous avez besoin pour aller avec DocSify, c'est un fichier de démarrage de base, ci-dessous certains modèles que vous pouvez utiliser qui montrent ce qui est possible avec la marque, les images, les paramètres d'URL et même quelques extraits HTML!
Pour utiliser ces modèles, vous effectuez généralement ce qui suit (les instructions spécifiques au modèle sont incluses avec chaque modèle):
Connectez-vous à GitHub ou créez un compte si vous n'en avez pas déjà.
Appuyez sur Utiliser ce modèle dans le référentiel de modèle choisi (bouton vert supérieur droit), puis choisissez Créer un nouveau référentiel
Choisissez le nom de votre nouveau référentiel pour contenir les fichiers, puis appuyez sur Créerter le référentiel pour copier les fichiers de modèle sur votre propre compte GitHub
Affichez un fichier Markdown inclus, par exemple Home.md , et copiez son URL.
Allez sur https://docsify- this.net et collez l'URL copiée dans le champ URL du fichier de marque
Sélectionnez les options de page souhaitées (par exemple, la barre latérale DoTify) et appuyez sur le bouton Publier en tant que page Web pour afficher votre fichier Markdown en tant que page Web pour partager ou intégrer
Pour modifier un fichier dans GitHub, appuyez sur l'icône du crayon (fichier de modification) dans le haut-droit lors de l'affichage du fichier, apportez vos modifications, puis appuyez sur le bouton Commit modifications ... pour enregistrer ces modifications.
Article d'une page Home.md Fichier affiché par Docsify-This As a:
Fichier Home.md Course Home.md affiché par Docsify-This en tant que:
Fichier Home.md Site Home.md, y compris l'utilisation de la classe Markdown CSS header-image-full-width , affichée par Docsify-This As:
Fichier de publication d'ouverture de plusieurs pages Home.md Fichier, y compris l'utilisation d'un fichier de barres latéraux personnalisés DoTify, affichée par Docsify-This AS:
Site de cours de plusieurs pages Home.md Fichier, y compris l'utilisation d'un fichier de barre latéral personnalisé et d'un fichier Navbar personnalisé DOCSIFY, affiché par docsify-this AS:
Exemples de pages, y compris l'utilisation des paramètres d'URL de la font-family , font-size et hide-credits pour le contenu transparent dans le canevas LMS, comme affiché par docsify-this:
Affichez un exemple de site Canvas LMS à l'aide de DocSify-ce contenu à https://canvas.sfu.ca/Courses/76692.
Docsify-this.net Open et collaboratif Workflow à l'aide de fichiers GitHub Markdown.
Docsify-this.net Workflow à l'aide de fichiers de marqueur WebServer.
Lorsque vous utilisez Docsify-This pour afficher des fichiers de démarque situés sur des services basés sur GIT tels que GitHub ou Codeberg, vous pouvez télécharger des fichiers (clone) sur votre bureau pour l'édition locale, puis télécharger (push) revient dans les fichiers en ligne.
Par exemple, pour modifier les fichiers GitHub Markdown sur votre bureau, vous effectuez ce qui suit:
En savoir plus sur le démarrage avec GitHub Desktop.
Les cours CSS suivants sont disponibles lors de la création de votre propre contenu Markdown.
< div class =" accordion " >
< details >
< summary > Topic One </ summary >
Topic one details here.
</ details >
< details >
< summary > Topic Two </ summary >
Topic two details here.
</ details >
</ div > < span class =' badge ' > Tue Jun 12th 11:59pm PDT </ span > < span class =' badge ' style =' --badge-bg-color: #0164db; ' > Tue Jun 12th 11:59pm PDT </ span > < span class =' badge ' style =' --badge-bg-color: #e7c500; --badge-text-color: #000; ' > Tue Jun 12th 11:59pm PDT </ span > < span class =' badge ' > [Tue May 16 2:30pm PT](https://www.timeanddate.com/worldclock/fixedtime.html?msg=CMPT-363+Blackboard+Mini-lectures+and+Activities&iso=20220516T1430&p1=256&ah=1&am=50) </ span > Cropué à une hauteur de 250px sur de grands écrans, 125px sur de petits écrans.
![ UX - User Experience ] ( images/12650723674_d5c85af332_k.jpg ' :class=banner-image ') Cropué à une hauteur de 350px sur de grands écrans, 175px sur de petits écrans.
![ UX - User Experience ] ( images/12650723674_d5c85af332_k.jpg ' :class=banner-tall-image ') [ Required Reading Quiz due Jun 4th ] ( https://canvas.sfu.ca/courses/44038/quizzes/166553 ' :class=button ') [ : fa fa-download fa-fw : Download ] ( https://creativecommons.org/wp-content/uploads/2019/02/ccheart_black.svg_.zip ' :class=button ') < a class =" button " href =" https://creativecommons.org/wp-content/uploads/2019/02/ccheart_black.svg_.zip " target =" _blank " > < i class =" fa fa-download fa-fw " > </ i > Download </ a > [ Required Reading Quiz due Jun 4th ] ( https://canvas.sfu.ca/courses/44038/quizzes/166553 ' :class=button-rounded ') [ : fa fa-download fa-fw : Download ] ( https://creativecommons.org/wp-content/uploads/2019/02/ccheart_black.svg_.zip ' :class=button-rounded ') < a class =" button-rounded " href =" https://creativecommons.org/wp-content/uploads/2019/02/ccheart_black.svg_.zip " target =" _blank " > < i class =" fa fa-download fa-fw " > </ i > Download </ a > [ Required Reading Quiz due Jun 4th ] ( https://canvas.sfu.ca/courses/44038/quizzes/166553 ' :class=button-secondary ') [ : fa fa-download fa-fw : Download ] ( https://creativecommons.org/wp-content/uploads/2019/02/ccheart_black.svg_.zip ' :class=button ') < a class =" button-secondary " href =" https://creativecommons.org/wp-content/uploads/2019/02/ccheart_black.svg_.zip " target =" _blank " > < i class =" fa fa-download fa-fw " > </ i > Download </ a > [ Required Reading Quiz due Jun 4th ] ( https://canvas.sfu.ca/courses/44038/quizzes/166553 ' :class=button-secondary-rounded ') [ : fa fa-download fa-fw : Download ] ( https://creativecommons.org/wp-content/uploads/2019/02/ccheart_black.svg_.zip ' :class=button-secondary-rounded ') < a class =" button-secondary-rounded " href =" https://creativecommons.org/wp-content/uploads/2019/02/ccheart_black.svg_.zip " target =" _blank " > < i class =" fa fa-download fa-fw " > </ i > Download </ a > Pour les aperçus d'articles liés, les diapositives / vidéos intégrées, etc.
< a class =" embedly-card " data-card-controls =" 0 " data-card-align =" left " href =" https://blog.prototypr.io/defining-usability-e7bf42e8abd0 " > Defining usability </ a > Largeur suggérée de 1200px à 2000px.
![ Photo of Mountain ] ( images/mountain.jpg ' :class=header-image-fade ') La largeur suggérée de 1200px à 2000px et l'affichage de la table des matières ne sont pas disponibles.
![ Photo of Mountain ] ( images/mountain.jpg ' :class=header-image-fade-full-width ') Taille suggérée de 1200px à 2000px de largeur et 400px à 600px de hauteur, et l'affichage de la table des matières n'est pas disponible.
![ Photo of Mountain ] ( images/mountain.jpg ' :class=header-image ') Échelle des images à%.
![ Photo of Mountain ] ( images/mountain.jpg ' :class=image-75 ') Échelle les images avec la bordure à%.
![ Photo of Mountain ] ( images/mountain.jpg ' :class=image-75-border ') ![ Photo of Mountain ] ( images/mountain.jpg ' :class=image-border ') ![ Photo of Mountain ] ( images/mountain.jpg ' :class=image-border-rounded ') [ GitHub ] ( https://github.com/hibbitts-design/docsify-this ' :class=navpill ') [ : fab fa-github fa-fw : GitHub ] ( https://github.com/hibbitts-design/docsify-this ' :class=navpill ') < a class =" navpill " href =" https://github.com " target =" _blank " > < i class =" fab fa-github fa-fw " > </ i > GitHub </ a > Rendez les images HTML brutes qui incluent des dimensions de taille réactives.
< img src =" https://raw.githubusercontent.com/hibbitts-design/publishing-with-docsify-this/main/images/docsify-this-web-page-builder.jpg " width =" 910 " height =" 682 " class =" responsive image-border " alt =" Docsify-This Web Page Builder " > < div class =" row " >
< div class =" column " >
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</ div >
< div class =" column " >
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</ div >
</ div > < div class =" row reverse-columns " >
< div class =" column " >
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</ div >
< div class =" column " >
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</ div >
</ div > < div class =" row " >
< div class =" column " >
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</ div >
< div class =" column-right " >
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
</ div >
</ div > < div class =" video-container-4by3 " > < div class =" video-container-16by9 " > < iframe width =" 560 " height =" 315 " src =" https://www.youtube.com/embed/lJIrF4YjHfQ " > </ iframe > </ div > Ajouté automatiquement à tous les iframes avec les domaines source «youtube.com» ou «docs.google.com».
< div class =" video-container-16by9 " > < iframe width =" 560 " height =" 315 " src =" https://www.youtube.com/embed/lJIrF4YjHfQ " > </ iframe > </ div > En plus des classes de Markdown CSS prises en charge par Docsify-This, vous pouvez également définir vos propres classes personnalisées dans vos fichiers de marque affichés, par exemple:
CSS dans le fichier Markdown:
<style >
. markdown-section . mybutton , . markdown-section . mybutton : hover {
cursor : pointer;
color : # CC0000 ;
height : auto;
display : inline-block;
border : 2 px solid # CC0000 ;
border-radius : 4 rem ;
margin : 2 px 0 px 2 px 0 px ;
padding : 8 px 18 px 8 px 18 px ;
line-height : 1.2 rem ;
background-color : white;
font-family : -apple-system , "Segoe UI" , "Helvetica Neue" , sans-serif;
font-weight : bold;
text-decoration : none;
}
< / style >Réduction:
[ Required Reading Quiz due Jun 4th ] ( https://canvas.sfu.ca/courses/44038/quizzes/166553 ' :class=mybutton ') Docsify-cela a été conçu pour afficher rapidement et facilement un ou plusieurs fichiers de démarche hébergés à distance. Pour une plus grande personnalisation du rendu des fichiers et pour garantir une disponibilité cohérente, même si l'instance publique de Docsify-This.NET n'était plus disponible, vous pouvez héberger votre propre instance de docsify-this.
To host your own instance on GitHub Pages, which also supports the option of a custom domain, fork or clone the Docsify-This repository to your GitHub account. Then, enable GitHub Pages using the /docs folder.
You can also have an instance of Docsify-This run on Codeberg such as https://docsify-this.codeberg.page by creating a new repository called pages , then choosing paulhibbitts/docsify-this-app in the template dropdown menu, choosing the Git Content (Default Branch) option and then tapping the Create Repository button.
Alternatively, you can upload the files in the Docsify-This /docs folder into a newly created Codeberg repository and then manually enable Codeberg Pages. An example Docsify-This instance running on Codeberg is available at https://codeberg.org/paulhibbitts/docsify-this-app, which uses a Branch renamed to pages .
If you want to run Docsify-This on your own Websever, create a destination folder on your server and then copy the files within the Docsify-This folder /docs to your newly created server folder. You could also use this docs folder as a custom domain root.
A more future-friendly setup would be to fork the Docsify-This repository (to support getting upstream updates) and use a GitHub Action such as FTP-Deploy to deploy all changed repository files to a webserver.
You can limit the domains which remote files can be rendered from by locating the line var allowedDomains = ''; within the index.html file and include your list of allowed domains separated by commas, for example var allowedDomains = 'codeberg.org,raw.githubusercontent.com,hibbittsdesign.org'; .
If you want to further customize and control the presentation of your Markdown content, especially when rendering multiple page sites, you can install your own Docsify Open Publishing Starter Kit (that this hosted web app is based on) and store all Markdown files within that site. You can learn more about the capabilities of Docsify itself at Docsify.js.org.
Looking for some help with getting a Docsify custom-This instance up and running for your organization? Paul provides a range of professional services related to Docsify-This - contact him to learn more.
The display of Font Awesome Free icons within Markdown content is supported with the following format:
: fas fa-home fa-fw :
The above Markdown is equivalent to the HTML markup <i class="fas fa-home fa-fw" aria-hidden="true"></i> .
When using the above shortcode for Font Awesome icons, it is assumed to be for decorative purposes, and so for improved accessibility an aria-hidden="true" attribute is automatically added to the icon. For semantic purposes, it is recommended you refer to the Font Awesome Icons and Accessibility guidelines.
The following style prefixes are available with Docsify-This:
GitHub Training Manual Working Locally with Git Markdown file, displayed by Docsify-This as a:
Easy Markdown to Github Pages linked set of Markdown files, displayed by Docsify-This as:
A Collection of GitHub Markdown files used as course content within an SFU CMPT-363 Canvas LMS site.
A Collection of GitHub Markdown files with inline CSS used as a multiple page SFU CMPT-363 course site with SFU visual branding and the Docsify Search plugin enabled, multiple page SFU CMPT-363 course site with SFU visual branding and website logo, and an example single Markdown file with default visual styling for embeddeding.
GitHub Markdown Content Demo file, displayed by Docsify-This as a Web Page with 'Edit this Page' link using the new GitHub.dev web editor (currently in Beta).
GitHub Markdown Content Demo file, displayed by Docsify-This as a Web Page with 'View raw Markdown' link.
Codeberg Markdown Content Demo file, displayed by Docsify-This as a Web Page with 'View raw Markdown' link.
GitHub's LaTeX Support Examples Markdown file, displayed by Docsify-This as a Web Page with an 'Edit this Page' link.
Mermaid-Docsify Example GitHub Markdown file, displayed by Docsify-This as a Web Page with an 'Edit this Page' link.
Docsify-This Multi-language Site Template, displayed by Docsify-This as a:
Docsify-This Simple Visual Portfolio Template (based on Notion Portfolio Template), displayed by Docsify-This as a:
Docsify-This Visual Portfolio Template (based on Notion Portfolio Template), displayed by Docsify-This as a:
A simple Markdown Student Portfolio Starter Template (based on Markdown Student Portfolio Template by Justin Thoreson) which is viewable on both GitHub and with Docsify-This.net, displayed by Docsify-This as:
Introduction to Docsify–This
Introductory, beginner to intermediate.
An introduction of Markdown publishing using the open source project Docsify–This.
Self-Publishing with Docsify–This
Intermediate, with a mix of basic and advanced aspects.
An overview to self-publishing with Markdown using the open source project Docsify–This, with a focus on digital literacy.
Use a page inspector to identify the font family and font size used in the platform you are embedding Docsify-This content in, and then pass that font family using the font-family (encoded, where spaces are replaced with '%20') and font-size (REM units) URL parameters to Docsify-This. For example, to match fonts with the Canvas LMS:
https://docsify-this.net?basePath=https://raw.githubusercontent.com/paulhibbitts/cmpt-363-222-pages/main&homepage=topics.md&font-family=Lato%20Extended,Lato,Helvetica%20Neue,Helvetica,Arial,sans-serif&font-size=1
If you want to include a Page Table of Contents with embedded Docsify-This content, but the destination platform screen area is not very wide, you might want to try the optional toc-narrow display option. For example, to use a narrower Table of Contents area that includes a smaller screen breakpoint: https://docsify-this.net?basePath=https://raw.githubusercontent.com/paulhibbitts/cmpt-363/main/docs/222&homepage=week-01.md&toc-narrow=true
Using Prismjs code blocks with syntax highlighting is supported for the languages included with Docsify and as well Bash, Go, Java, Kotlin, PHP, Python and Swift. To embed a code block use the Markdown standard of triple backticks and start the block with the name of the language, for example to embed a block of Javascript code with syntax highlight the following would be used:
```javascript
function test() {
console.log("Hello world!");
}
`` '
Which would then appear as:
function test ( ) {
console . log ( "Hello world!" ) ;
} The content of external Markdown files can be embedded into Docisfy-This web pages with the following:
[ included Markdown from same source location ] ( example.md ' :include ') [ included Markdown from URL ] ( https://raw.githubusercontent.com/paulhibbitts/Markdown-File-Tests/main/itworks.md ' :include ')For additional examples of including external content, view Docsify Embeded Files.
WikiLinks format for links and images are supported, as also found in the desktop editor Obsidian and other platforms.
The display of AsciiDoc files ('.adoc' extension) via DownDoc is possible by manually passing the relevant filenames within a Docsify-This URL (not available in the Docisfy-This.net Web Page Builder), for example: https://docsify-this.net/?basePath=https://raw.githubusercontent.com/asciidoctor/asciidoctor-pdf/main/examples&homepage=basic-example.adoc&edit-link=https://github.com/asciidoctor/asciidoctor-pdf/blob/main/examples/basic-example.adoc
You can support the display of AsciiDoc files in the Web Page Builder of your own instance of Docsify-This by locating the function getAllowedFileExtensions() within the index.html file and add the file extension '.adoc' to the return statement, for example return ".md,.adoc"; .
The display of HedgeDoc files containing basic Markdown (as well as Mermaid and MathJax elements) is possible by manually using 'download' for the homepage URL parameter within a Docsify-This URL (not available in the Docisfy-This.net Web Page Builder), for example: https://docsify-this.net/?basePath=https://demo.hedgedoc.org/crN3ispNQdejWkUXXIXYQA&homepage=download
Here is an additional example, using the HedgeDoc file https://demo.hedgedoc.org/oisWMy9ZS36PE6TvYhJC4A?both (seen in split-screen view) and and rendered as a web page by Docsify-This https://docsify-this.net/?basePath=https://demo.hedgedoc.org&homepage=oisWMy9ZS36PE6TvYhJC4A/download&edit-link=https://demo.hedgedoc.org/oisWMy9ZS36PE6TvYhJC4A?both&toc=true&edit-link-text=Edit%20this%20Page%20in%20HedgeDoc
You can support HedgeDoc URLs (eg https://demo.hedgedoc.org/ip4SRxZYTEKa6JHr62XTiA) in the Web Page Builder of your own instance of Docsify-This by locating the line var hedgedocInstances = ''; within the index.html file and include your HedgeDoc instances separated by commas, for example var hedgedocInstances = 'demo.hedgedoc.org'; . Try out a demo instance of Docsify-This with support for demo.hedgedoc.org files at https://hibbitts-design.github.io/hedgedoc-docsify-this.
You can use camel case instead of hyphens for the names of Docsify-This URL parameters if prefered. Par exemple, https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-one-page-article/main&homepage= home.md&toc=true&toc-headings=h2,h3&edit-link=https://github.com/hibbitts-design/docsify-this-one-page-article/blob/main/home.md et https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-one-page-article/main&homepage =home.md&toc=true&tocHeadings=h2,h3&editLink=https://github.com/hibbitts-design/docsify-this-one-page-article/blob/main/home.md are equilivent.
To use the new GitHub.dev web editor (currently in Beta) for 'Edit this Page' links, change github.com to github.dev for GitHub.com files entered into the Web Page Builder Markdown File URL field.
There are multiple ways to get a raw Markdown file available online, here are three options to help you get started:
GitHub or Codeberg:
Gist (GitHub Gists):
.md (eg myfile.md )Personal or Organizational Website:
Some text editors, such as Microsoft Visual Studio (including the online GitHub.dev web editor), have the ability to link your own CSS so Markdown previews are more visually accurate. If your editor supports this ability, the below CSS files can be used.
Docsify-This (based on the Docsify Open Publishing Starter Kit) CSS:
https://docsify-this.net/assets/css/editor.css
FontAwesome CSS:
https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.css
Enhanced Previews with Microsoft Visual Studio
For an even closer visual representation of your Docsify-This pages in Microsoft Visual Studio, do the following:
docs folderTIP: If you change the VSCode setting for Workbench › Editor: Show Tabs to single then the docsify preview area will remain in place as you edit multiple Markdown files.
You can load custom default settings in the Docsify-This Web Page Builder using URL parameters. This ability is especially helpful for Docsify-This online sessions, workshops, or when users collaborate and assist one another. Along with the standard Docsify-This URL parameters, the Web Page Builder also offers the following specific parameters:
https://docsify-this.net/?url-field=https://codeberg.org/paulhibbitts/docsify-this-one-page-course/src/branch/main/home.mdhttps://docsify-this.net/?url-field=empty You can even just type docsify-this.net? in front of an online Markdown file URL that you are viewing (such as files hosted on GitHub, Codeberg, or raw source files) to instantly set up the Docsify-This Web Page Builder with that file. Once the Web Page Builder loads, press the Return key — no need to leave the keyboard — to see Docsify-This display the Markdown file as a web page! For example, https://docsify-this.net?https://github.com/hibbitts-design/docsify-this-one-page-course/blob/main/home.md .
https://docsify-this.net/?url-field=https://codeberg.org/paulhibbitts/docsify-this-one-page-course/src/branch/main/home.md&edit-link-checkbox=truehttps://docsify-this.net/?show-page-options=truehttps://docsify-this.net/?advanced=true For example, the following URL will display the Advanced Web Page Builder, with the Markdown file URL set to https://github.com/hibbitts-design/docsify-this-multiple-page-course-site/blob/main/home.md , the site name 'CPT-363' along with a Docsify custom Sidebar and Navbar to be included: https://docsify-this.net/?url-field=https://github.com/hibbitts-design/docsify-this-multiple-page-course-site/blob/main/home.md&sidebar=true&loadSidebar=true&loadNavbar=true&name=CPT-363
The quickest way to create such a shareable URL is to use the Docsify-This Web Page Builder to generate a Docisfy-This web page URL, and then replace the URL parameter basepath with url-field using the full path of the source Markdown file URL. For example, the URL https://docsify-this.net/?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-one-page-article/main&homepage=home.md&sidebar=true&maxLevel=3 would be changed to https://docsify-this.net/?url-field=https://github.com/hibbitts-design/docsify-this-one-page-article/blob/main/home.md&homepage=home.md&sidebar=true&maxLevel=3.
The provided basePath parameter and/or optional homepage parameter may not be correct, verify that these items lead to accessible content. This error message may also result from a Cross-Origin Resource Sharing (CORS) policy, which restricts resources on a web page to be requested from another domain. If possible, relocate files to a domain that supports cross-origin requests or alternatively if the domain in question is under your control explore re-configuring CORS related settings. You can confirm the cause of the 404 message by viewing the errors displayed in the Browser Javascript Console.
When displaying GitHub Markdown files, the branch name is assumed to be main , and other paths will likely cause a 404 file not found message. When displaying Codeberg Markdown files, the path is assumed to contain /src/branch/main and other paths will likely cause a 404 file not found message.
Due to not being able to update Navbar or custom Sidebar links before page rendering, 'Edit this Page' links cannot be automatically updated to their correct target pages. Manually pass a URL pointing to the Git Repository using the URL parameter edit-link as a workaround, for example https://docsify-this.net?basePath=https://raw.githubusercontent.com/hibbitts-design/docsify-this-multiple-page-site/main&homepage=home .md&loadNavbar=_navbar&edit-link=https://github.com/hibbitts-design/docsify-this-multiple-page-site&edit-link-text=GitHub%20Repository et https://docsify-this.net/?basePath=https://raw.githubusercontent.com/paulhibbitts/docsify-this-cmpt-363-222-site/main&homepage=home.md&loadNavbar=_navbar.m d&sidebar=true&loadSidebar=_sidebar.md&edit-link=https://github.com/paulhibbitts/docsify-this-cmpt-363-222-site/tree/main&edit-link-text=GitHub%20Repository
Docsify is likely displaying the last cached version. To ensure the most recent version of a file is loaded, do a hard refresh of your Browser cache.
The most likely cause for embedded images in Markdown not being displayed as expected is the use of relative paths (ie  ) - review image paths and ensure the full path to each image is used (ie  ). Likewise, if images in HTML are not being displayed as expected the likely cause is again the use of relative paths (ie <img src="images/filename.jpg" alt="Alt Text"> ) - use absolute URLs for HTML image sources (ie <img src="https://raw.githubusercontent.com/user/repository/main/images/filename.jpg" alt="Alt Text"> ).
Due to iframe cross-domain issues embedded content may not be able to be displayed. Use the included rich media embed service embed.ly as a workaround.
For example, the following iFrame HTML:
< iframe src =" https://docs.google.com/presentation/d/e/2PACX-1vRnnRFelgw1ksq_p8Eryg3dnyLCRRLPf5fBgdwdv9p-tCIwcxqWvzDGrGbjxGHL7HqEJVpmV26ntk3a/embed?start=false&loop=false&delayms=3000 " frameborder =" 0 " width = 780 " height="585" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true" > </ iframe >Would be changed to:
< a class =" embedly-card " data-card-controls =" 0 " data-card-align =" left " data-card-width =" 100% " href =" https://docs.google.com/presentation/d/1BLaaOTsGxDmNcAhg6pdx3hl9IvI8NErg8Oe5ceh83fw/edit?usp=sharing " > Grav and Docsify Slides Placeholder </ a > When displaying a Docsify Sidebar or custom Sidebar, it is expected that page header levels start with a H1 level header.
When the search field is enabled in a Docsify custom Sidebar, only pages listed and linked in the Sidebar will be indexed for the search. Any pages linked in an optional Navbar will not be included in searches.
Docsify-This (as with Docsify itself) will only execute the first script included in a Markdown page, as described in the Docsify documentation.
Have you tried out Docsify-This? Share your feedback about Docsify-This
By leveraging his extensive UX design expertise and systems-oriented approach, Paul helps teams and individuals utilize open content in a range of education and publication settings, especially in connection with his Markdown-based Docsify and Grav CMS open-source projects. Professional services include user experience and workflow consulting, premium support subscriptions, workshops, and custom development. Sound of interest? Send a note to [email protected].
This open source project is by Paul Hibbitts of HibbittsDesign.org.
??♂️Special Thanks
Beau Shaw for his Remote Docsify example.
Alan Levine for the inspiration of a consolidated ReadMe collection.
