Skip to content

Commit 8caf8b0

Browse files
committed
docs: Update instructions
1 parent 3a214a5 commit 8caf8b0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,13 +215,13 @@ Jekyll and Hugo are options for static site generators which can use themes suit
215215
216216
A static site generator can be heavy...
217217
218-
There are dependencies to manage. Such as plugins and themes for _Jekyll_. And plugins for _Hugo_. Plus one or more external _JavaScript_ or _CSS_ files are probably used in the HTML, such as _JQuery_.
218+
There are dependencies to manage - they might have to be upgraded if their are security vulnerabilities or they are no longer available. Such as plugins and themes for _Jekyll_. And plugins for _Hugo_. Plus you probably need a couple of _JavaScript_ or _CSS_ files that either you or a theme added. Such as _Query_. This _Docsify_ project only needs exactly one _JavaScript_ and one _CSS_ file.
219219
220220
There is HTML to build locally and on the remote. While _Docsify_ needs no dependencies to serve a site, _Jekyll_ sites needs `jekyll` installed and _Hugo_ sites need `hugo` available.
221221
222222
A static site needs to to customize it in depth or setup a theme which also takes effort. You may lose or gain functionality when switching between Jekyll themes because they use their own templates and layouts.
223223
224-
You probably have to add _frontm atter_ to your doc files so they can inherit from layouts and have the correct metadata like title.
224+
You probably have to add _front matter_ to your doc files so they can inherit from layouts and have the correct metadata like title.
225225
226226
As with _Docsify_, you will probably have to create a config file which covers the structure of your project for use in the sidebar.
227227

0 commit comments

Comments
 (0)