Giter Club home page Giter Club logo

documentation's Introduction

Documentation

Overview

This repo holds the markdown files of Steeltoe documentation in the docs sub-folder and a markdown parser console app. The app converts the markdown to HTML using the Markdig library. It also uses the contents of docs/nav-menu.yaml to create a toc.json (table of contents).

The pipeline attached to this repo creates an artifact that holds the created files, in a specific folder structure. The MainSite repository contains the release pipelines that copy the contents of this artifact into the wwwroot folder during deployment.

Directory Locations

  • Documentation - All markdown documentation is located under the docs folder. These are the files that need to be modified for updates to the documentation section on the website.

  • The markdown parser - This converts the markdown files to html and is located under src.

Build

  • Running the markdown parser
    • Usage: > dotnet run --project src/ParseMD <location-of-markdown-files> <output-html-directory>
    • Example Usage: > dotnet run --project src/ParseMD <location-of-markdown-files> <output-html-directory>

Related Repository

  • MainSite - This repository contains the main site builder for steeltoe.io. It pulls in the html from the output of ParseMD and adds it to the documentation section of steeltoe.io.

documentation's People

Contributors

ccheetham avatar ddieruf avatar hananiel avatar jkonicki avatar jonorossi avatar timhess avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.