Learn Docfx for your Doc site

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project.

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project.

๐Ÿ‘ฉ๐Ÿปโ€๐Ÿš€ Creativitas

๐Ÿ”– microsoft docfx learn jamstack static site generator

DocFx awesome microsoft web technology framework #

Docfx can be used as a static site generator, but the real value of the tool is in bringing together static documentation pages and .NET API documentation. Docfx supports both C# and VB projects (although currently the output of tool is limited to C# syntax), and relies on the long-established XML comment syntax for C# (and similarly for VB)

What is DocFx ?? #

Build your technical documentation site with docfx. Converts .NET assembly, XML code comment, REST API Swagger files and markdown into rendered HTML pages, JSON model or PDF files.

Why we need learn DocFx ?? #

Docfx is a powerful tool but easy to use for most regular use cases, once you understand the basic concepts.

Let develop your first documentation site with DocFx #

For fist we need to download dotnet SDK - you can download dotnet SDK here

Download and install dotnet in to your devices, next you test with open your bash terminal and run dotnet , next you can run dotnet tool update -g docfx

Ok, its time to build your first documentation project, create a new project folder in to your devices, and run docfx init and insert your project name and others.

Now you can open on your projectfolder

Configure your DocFx project #

For first configure your site open docfx.json and change this line code

"globalMetadata": {
      "baseUrl": "yourdomain url here..",
      "_appName": "Your doc app name",
      "_appTitle": "Your title",
      "_enableSearch": true,
      "_lang": "en", # your default lang code
      "_appFooter": "Your copyrigths text on fotter",
      "pdf": true
    }

Add sitemap plugin in to DocFx #

Now we need to add the sitemap plugins for support your SEO , add this line code in to docfx.json

    "sitemap": {
    "baseUrl": "Your domain name here..",
    "priority": 0.1,
    "changefreq": "monthly"
    },

Write your Documentation Article #

What Next ??

Of course we need to write your documentation article, open docs folder and write your documentation content article.We can add meta title and description too. you can use this frontmatter format

---
title: Your title goes here...
description: Your Description goes here...
---
# Hello World

This is my article for documentation....

Setup Header Nav DocFx #

Ok, next we can setup your header navigation, access on root your documentation project folder and open toc.yml file.

- name: Home
  href: index.md # this is for single page link
- name: Documentation
  href: docs/ # This is for access your docs folder

For single page file such index.md or about.md you can simply add markdown file name in to href

If you want to add folder in to navigation header, you can simply add your folder name , for example look like this docs/

Run DocFx #

Now we can run dev mode on your local device, open terminal and run docfx docfx.json --serve

Open localhost:8080 on your web browser

Congratulations your site is live now !!

Build Production DocFx #

Next if you want to upload in to your hosting, so you need to build production run this command docfx docfx.json

And now you can upload the build production folder _site in to your hosting.

Deploy to Github Page #

If you want to deploy in to github pages, you just need to upload _site folder on your github repo, next you can activate your github page features.


And if you need website documentation development services with Docfx or Docusaurus, Starlight astro js and python tech MkDocs or Sphinx, our team is ready to help you.

Order Documentation Website Developer Services

Need a complete website and blog with modern JAMSTACK Static Site Generator ?? you can hire our team dev

Order Static Site Generator Web Services


Blog Update โœ๏ธ

The latest information from our blog articles, for website development technology reviews, and learning.

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project.

Learn Docfx for your Doc site

๐Ÿ‘ฉ๐Ÿปโ€๐Ÿš€ Creativitas

๐Ÿ”– microsoft docfx learn jamstack static site generator

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project.

You should try using pelican, mkdocs , sphinx and nikola for your website project

The best Python Jamstack SSG for your projects

๐Ÿ‘ฉ๐Ÿปโ€๐Ÿš€ Creativitas

๐Ÿ”– python pelican mkdocs nikola jamstack static site generator

You should try using pelican, mkdocs , sphinx and nikola for your website project

If you want to build complete documentation web project, so docusaurus is the best chocie for you.

Build Complete Documentation Website with Docusaurus

๐Ÿ‘ฉ๐Ÿปโ€๐Ÿš€ Creativitas

๐Ÿ”– documentation docusaurus jamstack static site generator

If you want to build complete documentation web project, so docusaurus is the best chocie for you.

Explore All Blog Post โ†’

Our Services ๐Ÿ‘จโ€๐Ÿš€

List our services with the latest technology, to develop your modern website application projects.

Explore all Web Dev Services โ†’

Themes Template Project ๐ŸŽญ

Multipurpose blog website themes and documentation templates to help your projects, built with a variety of technologies.

New Modern Minimalist JAMSTACK CMS 11ty eleventy Static Site Generator Themes

New Modern Minimalist JAMSTACK CMS 11ty eleventy Static Site Generator ThemesEleventy 11ty Eleventy 11ty

Minimalist Jamstack Themes

eleventy 11ty fast jamstack static site generator tina cms tina cloud minimalist template

JAMSTACK JAMSTACK

Jamstack Themes Jamstack Themes

Minimalist Template Minimalist Template

JSON Data JSON Data

Static Site Generator Static Site Generator

Backend Admin Ready Backend Admin Ready

Minimalist Jamstack Themes info

New Modern Company portfolio bussiness site JAMSTACK 11ty eleventy Static Site Generator Themes

New Modern Company portfolio bussiness site JAMSTACK 11ty eleventy Static Site Generator ThemesEleventy 11ty Eleventy 11ty

Company Portofolio Themes

eleventy 11ty fast jamstack static site generator portfolio bussiness template

JAMSTACK JAMSTACK

Company Themes Company Themes

Bussiness Template Bussiness Template

JSON Data JSON Data

Static Site Generator Static Site Generator

Backend Admin Ready Backend Admin Ready

Company Portofolio Themes info

Build a fast website run on jekyll ruby โ€‹โ€‹on rails, with full features, futuristic design and Automated SEO injection scripts.

Build a fast website run on jekyll ruby โ€‹โ€‹on rails, with full features, futuristic design and Automated SEO injection scripts.Jekyll Jekyll

Cuber the New Jekyll Themes Template

jekyll jamstack static site generator multipurpose futuristic template

Ruby On Rails Tech Ruby On Rails Tech

Jekyll Jekyll

For Multipurpose Web For Multipurpose Web

Dark Mode Concept Dark Mode Concept

YAML Data YAML Data

Markdown Content Markdown Content

Cuber the New Jekyll Themes Template info

Explore All Themes Template Projects โ†’

Our SEO Services ๐Ÿ•น๏ธ

We also provide services to help improve your website performance.

Explore All Our SEO Services โ†’


Our Source Code Project ๐ŸŽฎ

Free download at no cost, we share complete open source code, to help you, here are our best free projects.

Clean and Minimalist design minimals free download pelican themes template source code project
https://res.cloudinary.com/dp1ndwq6a/image/upload/w_20/f_avif/v1717080370/creativitas-netlify/webtech/pelican_rhom8n.png

Pelican Minimals

Pelican Minimals Bludit JSON 5

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Python Technology

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Pelican Static Site Generator

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. For Multipurpose Blog and Docs

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Complete Set Project

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Markdown Ready

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Configuration Site

Download Pelican Minimals

The starter themes for 11ty eleventy with the lastest version for build your documentation website project free download full source code
https://res.cloudinary.com/dp1ndwq6a/image/upload/w_40/c_thumb/q_auto/f_avif/v1705657338/creativitas-netlify/webtech/eleventydeveloper_g8ua9d.png

Documentation Site 11ty

Documentation Site 11ty 11ty 5

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Eleventy 11ty

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Docs Design

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. For Documentation Site

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Markdown Files

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. JAMSTACK

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Static Site Generator

Download Documentation Site 11ty

The starter themes for 11ty eleventy with the lastest version integration with tina cms for your project - free download
https://res.cloudinary.com/dp1ndwq6a/image/upload/w_40/c_thumb/q_auto/f_avif/v1705657338/creativitas-netlify/webtech/eleventydeveloper_g8ua9d.png

Blog 11ty TinaCMS

Blog 11ty TinaCMS 11ty 5

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Eleventy 11ty

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Blog Design

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. For Multipurpose

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Markdown Files

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. JAMSTACK

What is docfx ?? and why we need to learn it - get start now with docfx and built your documentation site project. Static Site Generator

Download Blog 11ty TinaCMS

Explore All our Source Code Project โ†’

Need Help or Information ??

If you need help or information you can contact our team dev.