Matthieu Vincentyodamad.hashnode.dev·Jun 24, 2024Some cool plugins for your mkdocs based siteIn a previous article, I've discovered a super cool tool to make nice documentation site : mkdocs. In this article, I'll present some nice plugins available in mkdocs ecosystem (which is very rich BTW, a catalog is available here for a quite complete...Discuss·1 like·49 readsmkdocs
RANDY DUODUisolveit.hashnode.dev·Jun 10, 2024Why Docs-as-Code is the Key to Better Software DocumentationIntroduction In the software development ecosystem, there is often friction between software developers and technical writers when it comes to creating and contributing to software documentation. One reason for this issue is that these two key player...Discuss·33 readsdocumentation
Etugbo Judithjudy.hashnode.dev·May 7, 2024How to create a Documentation Site Using MkDocsIntroduction In my recent article, I wrote a guide on how to build a documentation site using Docsify and Github pages. Today, you will learn how to build your site with MkDocs, as we have numerous static site generators(SSG) you can leverage. Static...Discuss·10 likes·134 readsmkdocs
Matthieu Vincentyodamad.hashnode.dev·Dec 22, 2023Beautiful Pages on GitLab with mkdocsGitLab have a nice feature to easily generate a static website from markdown files. It's called GitLab Pages. Even if it's a very useful feature for instance to share some technical documentation on a project, it can be quite painful to make it nice ...Discuss·2 likes·1.9K readsGitLab
Peace Sandypeacesandy.hashnode.dev·Sep 12, 2023How to use MkDocs to Create a Technical Documentation SiteDocumentation is an essential aspect of the software engineering process. As you work on any project, documentation is really crucial. Software documentation is a way for software engineers and programmers to create, maintain, and share information i...Kennedy Ekanem and 2 others are discussing this3 people are discussing thisDiscuss·37 likes·136 readsmkdocs
Temitope Victoriatemitopevictoria.hashnode.dev·Sep 12, 2023Getting Started with Mkdocs: A Beginner's Guide.Introduction The digital age has brought about modern technologies. Businesses are evolving using complex technologies. These technologies require user manuals, user guides, and documentation to state how to use them explicitly. Building documentatio...Discuss·2 likesTechnical writing
Dasilva Akoredecoreyodonis.hashnode.dev·Sep 10, 2023A beginner guide to using MKDocsIntroduction to MKDocs What is Mkdocs MKDocs is a documentation tool that processes Markdown files into static website. It is an open-source python-based static site that focuses on speed and simplicity. Documentation source files are written in Mark...Discussmkdocs
Susan Odiisusanodii.hashnode.dev·Jul 18, 2023How to build documentation with MKDocsIntroduction We live in a Digital Age, an era where there is accelerated technological progress. Many businesses are now using technology to advance their businesses. Developers as well as business owners are constantly building products with the lat...Nkem Onyemachi and 5 others are discussing this6 people are discussing thisDiscuss·55 likes·485 readsdocumentation
Onyeanuna Princeaahil13.hashnode.dev·Jul 18, 2023A Beginners' Handbook into MKDocsStatic site generators are tools that you can use to generate HTML, CSS, and JavaScript files from templates using various languages such as Markdown, HTML, etc. Static site generators have a faster load time because they pre-build all their pages, u...Discuss·5 likes·104 readsmkdocs
Tinz TwinsProhub.tinztwins.de·Jun 25, 2023Create a Stunning Documentation for Your Plotly Dash App with MkDocsGenerated with Bing DALL-E Our experience has shown that software projects are often insufficiently documented. But why? Most software projects have a limited budget and a tight schedule. Documentation is then often neglected. Insufficient documentat...Discuss·7 likes·41 readsPlotly Dash