These lines use content delivery network (CDN) URLs to serve the CSS and JavaScript scripts to transform the site into a Docsify site. This is essentially just a plain HTML file, but take a look at these two lines: Open the file, so you can explore the contents: Index.html is the only thing required for Docsify to work. The default Markdown file at the root of your documentationĬontains a sample. The main Docsify initiation file (and the most important file) (Bryant Son, CC BY-SA 4.0) File/Folder Name If you cloned my GitHub repo and changed into the DocsifyDemo directory, you should see a file structure like this: If you prefer, you can start from scratch by creating a new index.html file, like in the example in Docsify's docs: I will walk you through the cloned code from my sample repo below, so you can understand how to modify Docsify. You can download the files individually or clone the repo with: git clone I've published this example's source code on the project's GitHub page. If you want to use NPM, follow the instructions in the quick-start guide. Manually by writing your own index.htmlĭocsify recommends the NPM approach, but I will use the second option.Docsify's command-line interface (CLI) through NPM.eBook: An introduction to programming with Bash.Try for free: Red Hat Learning Subscription. ![]() ![]() Docsify is an MIT-Licensed open source project with features that make it easy to create an attractive advanced documentation site on GitHub Pages. While this setup is nice, I wanted to try something else.įortunately, GitHub Pages' HTML file support means you can use other site-generation tools, including Docsify, to create a website on the platform. Jekyll generates a static website from documentation files encoded in Markdown format, which GitHub automatically recognizes due to their. If you prefer to learn by video, you can access the YouTube version of this how-to:īy default, GitHub Pages prompts users to use Jekyll, a static site generator that supports HTML, CSS, and other web technologies. In this tutorial, I'll show you one option for doing so: combining the Docsify documentation generator with GitHub Pages. This is why making it easier to publish documentation is so valuable to developers. But it's not always developers' top priority, as they may be more focused on making their application better than on helping people use it. Documentation is an essential part of making any open source project useful to users.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |