Giter Club home page Giter Club logo

console-docs's Introduction

Windows Console Documentation

Welcome to the Windows Console documentation repo. The MSDN Console Docs are generated from the markdown stored in this repo. The published docs can be found at https://docs.microsoft.com/windows/console/

For code issues related to the Windows Console, Windows Terminal, and related command-line and terminal tooling products acquired with Windows, from the Windows Store, or other sources like GitHub, please check out the microsoft/terminal repository.

Metadata

Each content page in this repo requires some metadata expressed as YAML, stored at the top of each doc between '---' markers. For example:

---
title: About Consoles
description: Consoles provide high-level support for simple character-mode applications that interact with the user by using functions that read from standard input and write to standard output or standard error.
author: miniksa
ms.author: miniksa
ms.assetid: 39204f0e-b0b8-4f92-af8e-e146ac06c454
ms.topic: article
---

# About Consoles

Consoles provide high-level support for ...

Notes on metadata:

  • author: Main article author
  • ms.author: Additional co-authors / contributors / editors
  • ms.assetid: UUID used by BI for reporting and analysis. Generated by CAPS for existing content, auto-generated by OPS in future
  • ms.topic: One of [article | get-started-article | hero-article | hub-page | landing-page | non-content | reference | search] (see this Excel workbook for current valid values).

While some metadata is stored per file (e.g. above), common metadata required by all files within a documentation set (docset) is stored in the docfx.json file in the root of the docs folder, e.g.:

  "build": {
    #...
    "fileMetadata": {
      "ms.prod": { "/console/**.yml": "windows"},
      "ms.technology": { "/console/**.yml": "desktop"},
      "manager": {"/console/**.yml": "miniksa"}
    }
  }
}

The values for ms.prod and ms.technology are standard for Win32 API's & desktop technology, as defined in the Excel workbook above. Custom values can be registered if required.

console-docs's People

Contributors

alexandair avatar bitcrazed avatar craigloewenms avatar cuchalin avatar darjeeling-uk avatar ddv239 avatar dennislee-dennislee avatar dhowett avatar fenxu avatar gobigorgohome avatar imba-tjd avatar jonahgraham avatar lafe avatar lzybkr avatar mattwojo avatar mauricekayser avatar mgblythe avatar miniksa avatar pacort avatar ratijas avatar rsola avatar saldana avatar samb avatar timsneath avatar toxaris avatar turingcompl33t avatar vap0r1ze avatar vsc-service-account avatar zadjii-msft avatar zenflow 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.