Le Node le plus simple.js CMS & SSG!
Une petite flamme dans l'obscurité de l'erreur ...
Important
Cette documentation ne représente plus les diverses fonctionnalités de Blog-Doc. Veuillez consulter la documentation complète des informations à jour sur les fonctionnalités de Blog-Doc.
Pour installer Blog-Doc sur l'espace, rendez-vous sur sa page d'installation et cliquez sur le bouton Install App
.
Une fois installé, ouvrez l'application à partir de votre horizon ou en accédant à l'instance Builder de l'application et en cliquant sur le bouton Open Builder Instance
.
Vous serez redirigé vers l'adresse de l'application et verrez dans votre navigateur le message suivant: Route Not Found
.
S'il vous plaît, ne paniquez pas! J'ai essayé d'autres façons, mais c'est la plus simple et la plus sécurisée.
En supposant maintenant que votre instance de Blog-Doc a l'adresse suivante:
https://abc-1-x234.deta.app
, dans la barre d'adresse de votre navigateur.
Ajouter après /admin-blog-doc-config
, l'adresse est maintenant:
https://abc-1-x234.deta.app/admin-blog-doc-config
, appuyez sur Entrée.
Vous serez redirigé vers une page qui vous guidera sur la définition de la configuration principale pour commencer à utiliser le blog-doc, 2 étapes faciles de 2 minutes.
À la fin, vous soumettez un formulaire, il faut au plus 30 secondes pour télécharger la configuration, puis vous serez redirigé vers l'adresse initiale https://abc-1-x234.deta.app
et revenez: Route Not Found
.
Encore une fois, ne paniquez pas! Ajoutez simplement `/ pages / documentation '' après l'adresse. Parcourez l'application pendant une minute (temps pour que le code interagisse avec le lecteur nouvellement créé) sans visiter l'itinéraire domestique, puis allez sur l'itinéraire principal et commencez à utiliser votre propre instance de blog-doc?
Si cela ne fonctionne pas dès la première fois, recommencez une fois de plus et il le fera.
siteURL
avant de déployer la demande.
Nota Bene: L'URL en direct doit se terminer par une barre oblique /
Bien sûr, vous devez également modifier siteTitle
, siteDescription
et rssCopyright
dans la page Paramètres.
Vous devez remplacer les valeurs siteTitle
, siteDescription
et rssCopyright
par celles de votre site.
Vous pouvez remplacer la valeur rssSiteLanguage
par la langue de votre site.
Une liste des codes linguistiques disponibles peut être trouvée sur la page des codes de langue RSS.
⬆️ Retour aux fonctionnalités
Comme le flux RSS, vous devez fournir l' URL en direct de votre site dans la page Paramètres en modifiant la valeur siteURL
pour générer les liens corrects pour chaque page, publication, balise et modèle ainsi que pour les itinéraires de blog.
N'oubliez pas que l' URL du site doit se terminer par une barre oblique /
Vous pouvez vérifier le plan du site de votre site sous la route /sitemap
.
⬆️ Retour aux fonctionnalités
Blog-Doc a une fonction de recherche intégrée.
La fonctionnalité de recherche permet à un utilisateur de faire une recherche sur les titres et le contenu des publications.
Vous pouvez vérifier la recherche de votre site sous la route /search
.
Vous pouvez désactiver la recherche dans l'application Node.js ainsi que pour le site statique généré en donnant searchFeature
une valeur de false
dans la page des paramètres du site.
⬆️ Retour aux fonctionnalités
Blog-Doc utilise Highlight.js pour mettre en surbrillance le bloc de code .
Pour écrire du code en ligne , entourez votre code de backticks ``
.
Pour le mettre en surbrillance, fournissez la langue du code en ligne en mettant après un accolade bouclé avec l'alias de la langue du code.
Les exemples suivants vous donneront une meilleure idée.
En supposant que cette ligne css
p : color { red }
, pour la mettre en surbrillance, vous écrirez `p { color: red }`{language=css}
.
Le code est entouré de backticks ``
et suivi de {language=alias of code language}
.
Pour écrire un bloc de code , entourez votre bloc avec une paire de 3 backticks ```
.
Pour le mettre en évidence, fournissez l'alias de la langue pour le bloc juste après les 3 premiers backticks.
Nous allons prendre l'exemple précédent et le mettre en évidence en bloc:
```css
p { color: red }
```
Nous obtiendrons la sortie suivante:
p {
color : red;
}
Visitez les langues prises en charge de Highlight.js pour obtenir le bon alias si vous n'êtes pas sûr.
Alternativement, vous pouvez écrire un bloc de code sans fournir un alias, Highlight.js détectera automatiquement la langue.
Si le surligneur ne détecte pas la langue correcte pour un bloc de code sans alias, ajoutez simplement la langue souhaitée au bloc comme indiqué ci-dessus.
⬆️ Retour aux fonctionnalités
L'ajout d'un attribut id
à une balise d'en-tête, H2 jusqu'à H4 uniquement, est une fonctionnalité activée en option par défaut.
Cette fonction a été construite avec des étuis à bord et des fautes de frappe à l'esprit:
Pour ajouter un id
, ajoutez un accolade bouclé avec un hashtag suivi du texte de l'ID.
Les exemples suivants vous donneront une meilleure idée:
<!-- Heading tags with an id property -->
## My awesome H2 title {# my-awesome-h2-title}
The HTML output will be : < h2 id = " my-awesome-h2-title " >My awesome H2 title</ h2 >
### My awesome H3 title {# my awesome h3 title}
The HTML output will be : < h3 id = " my-awesome-h3-title " >My awesome H3 title</ h3 >
#### My awesome H4 title {# My awesome H4 title}
The HTML output will be : < h4 id = " my-awesome-h4-title " >My awesome H4 title</ h4 >
Chaque espace blanc est automatiquement remplacé par un trait d'union et tout nombre de tirets consécutifs sont remplacés par un seul trait d'union.
Un nombre de trait d'union au début ou à la fin du texte de l'ID est supprimé, donc ce qui suit est également valide:
## My awesome H2 title { # ----- My ----- aWEsOMe ----- h2 ----- tITlE ----- }
Whatever the number of whitespace characters / hyphens is at the beginning,
between the words or at the end, the HTML output will still be :
< h2 id = " my-awesome-h2-title " >My awesome H2 title</ h2 >
Tout ce que le dernier hashtag est ignoré et les caractères spéciaux du texte de l'identification sont également ignorés:
## My awesome H2 title { /!@# a comment ?%^& # -my= awesome+ h2 ( title ) | }
The HTML output will be : < h2 id = " my-awesome-h2-title " >My awesome H2 title</ h2 >
& will be parsed to amp (ampersand)
" will be parsed to quot (quotation)
> will be parsed to gt (greater then)
< will be parsed to lt (less then)
Par exemple:
## Honey & Bees {#Honey & Bees}
The HTML output will be : < h2 id = " honey-amp-bees " >Honey & Bees</ h2 >
Si vous souhaitez désactiver cette fonctionnalité, définissez la valeur addIdsToHeadings
sur false
dans la page Paramètres du site.
⬆️ Retour aux fonctionnalités
Étant donné que Blog-Doc s'est transformé en CMS, j'ai prévu d'ajouter une galerie et un moyen de récupérer des images pour les pages et les publications directement.
Maintenant, c'est presque fait. Presque, car il y a toujours de l'espace pour apporter des améliorations.
Pour l'instant, vous pouvez visiter la galerie en appuyant sur l'itinéraire /admin/gallery/images
, ou accéder à la page d'administration et cliquez sur le lien de la galerie dans le menu ou sa carte.
Dans l'esprit mondial de Blog-Doc, la cuisine est assez simple à utiliser.
Vous trouverez une zone de dépôt où vous pouvez supprimer vos images ou cliquez dessus et choisissez la ou les images que vous souhaitez télécharger.
Vous pouvez également supprimer une image de la galerie en cliquant sur son bouton de supprimer .
Enfin, pour attribuer une image à une page ou à un message, vous pouvez, tout en créant ou en créant, choisissez une image dans la galerie en la sélectionnant directement dans la page ou la publication.
⬆️ Retour aux fonctionnalités
(à venir bientôt dans l'espace)
Vous pouvez basculer entre les thèmes et choisir la conception qui convient à vos besoins.
Blog-Doc est livré avec:
Si une image vaut mille mots, une vidéo vaut un million!
Une vidéo de 30 secondes montrant la possibilité de changer instantanément l'apparence de votre site avec Blog-Doc.
J'ajouterai plus de thèmes à Blog-Doc au fil du temps.
Si vous avez codé un thème pour Blog-Doc et que vous souhaitez l'énumérer parmi les thèmes disponibles, vous pouvez me le faire savoir dans les discussions du référentiel de Blog-Doc dans la catégorie Idées.
Veuillez garder à l'esprit que les thèmes de blog-doc ne doivent utiliser que JavaScript simple et ne peuvent contenir aucun code ou image qui a des restrictions de publication et / ou de distribution!
⬆️ Retour aux fonctionnalités
Avec tout le respect dû au temps et au travail acharné de chaque développeur qui a fait un générateur de sites statique avec Node.js, y compris les versions précédentes de Blog-Doc , ce sont GasWorks!
J'offre mes excuses les plus sincères à l'avance à chacun de ces développeurs, mais une application n'est pas censée être un Gasworks ...
Bien que les articles suivants ne soient plus pertinents pour la version réelle de Blog-Doc, ils expliquent assez bien ma motivation et peuvent vous choquer.
Veuillez lire de 145 à 7?
Lisez également le nouveau blog-doc
Lisez également Node_Modules n'est pas lourd, les développeurs sont paresseux!
Blog-Doc pour l'espace n'utilise désormais que 14 modules (1916.1 Ko ou 1,9161 Mo) au lieu de 131 (10082 Ko ou 10,082 Mo)!
Accédez à la page des problèmes de l'espace de blog-doc sur GitHub et créez un nouveau problème en expliquant autant que possible le problème auquel vous êtes confronté.
Accédez aux idées de l'espace de blog-doc sur Github et parlez-moi de cela.
L'inclusion du SSG dans Blog-Doc sur l'espace nécessite des modifications d'architecture.
Je considérerai plus tard pour inclure le SSG ou ne pas en fonction de l'utilisation et des exigences de Blog-Doc sur l'espace.
Veuillez lire la section d'installation.
J'ai l'intention de faire beaucoup d'améliorations à cette application pendant mon court laps de temps libre.
Vous pouvez prendre Blog-Doc en tant que prototype et le modifier totalement pour l'utiliser avec une autre conception et / ou une autre langue de modèle.
J'espère vraiment que cette application sera utile de quelque manière que ce soit pour beaucoup de gens là-bas, je le considère comme ma contribution personnelle aux communautés Node.js et Markdown.
Les idées, les commentaires et les suggestions sont les bienvenus.
Sya, Lebcit
Construit avec ❤️ par lebcit