Code Monkey home page Code Monkey logo

edge-developer's Introduction

Microsoft Edge Developer documentation

Microsoft Open Source Code of Conduct

See Microsoft Open Source Code of Conduct.

Legal Notices

Microsoft and any contributors grant you a license to the Microsoft documentation and other content in this repository under the Creative Commons Attribution 4.0 International Public License (see LICENSE), and grant you a license to any code in the repository under the MIT License (see LICENSE-CODE).

Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. Microsoft general trademark guidelines can be found at Microsoft Trademark and Brand Guidelines.

Privacy information can be found at https://privacy.microsoft.com.

Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise.

Contributing

This repo, edge-developer, is the repository for the source Markdown files for the Microsoft Edge Developer documentation. The resulting rendered documentation is hosted at Microsoft Edge documentation. This repo also includes the hub page for the Microsoft Edge Enterprise documentation and the Microsoft Edge Developer documentation. The source files for the Microsoft Edge Enterprise documentation aren't in this repo, but are in the Edge-Enterprise repo.

If you want to include new coverage or have feedback, consider contributing. You can edit the existing content, add new content, or report new issues. The Microsoft Edge team reviews a look at your suggestions and works to incorporate the suggestions into the docs.

Find the data for the Status webpage at: https://github.com/MicrosoftEdge/Status. The Status webpage provides the latest implementation status and future plans for web platform features in Microsoft Edge.

File names and directories

  • When adding a webpage (an article implemented as a .md file), you must add an entry for the new webpage in toc.yml, for the article to appear in the Table of Contents.

  • A directory can contain more directories or readme.md files.

  • Folder/directory names are dash-separated (for example, f12-tools) and lowercase. Directories are used in URLs on the docs.microsoft.com site. Avoid using underscores, PascalCase, or camelCase.

Markdown tagging

This repo uses simple Markdown tagging that's standard for docs.microsoft.com per the Docs Contributor Guide.

Lists

These other text elements have styling available:

  • Unordered lists
  • Have regular bullets
    • You can also nest bullets.
    • Bullets lists should have more than one entry.
  • Standard arrangement
  1. Ordered lists.
  2. Use regular western-style numbering.
  3. Should be used only when a list truly has order.

See Lists (Numbered, Bulleted, Checklist) in the Docs Contributor Guide.

Links

See Use links in documentation in the Docs Contributor Guide.

Formatting code blocks

To format inline code in mid-sentence, such as a functionName, wrap the code with backticks. A backtick is an angled single quote, typically in the upper left of the keyboard.

Or you can display multi-line blocks of code. The following code snippet is a CSS example.

body {
    background: #fff;
}

Valid coding languages, used for syntax coloring, include the following, and more. Other values are usually safe; unknown "slug" strings are rendered the same way you type them.

Slug Rendered as
html HTML
css CSS
javascript JavaScript
typescript TypeScript
json JSON
cpp C++
console Console

For example, type three backticks and then the "css" slug.

See How to include code in docs in the Docs Contributor Guide.

Tables

You can use column headings on tables
Left-aligned Unless a # 456
Text value More text $0.00

See Tables in the Docs Contributor Guide.

Notes (alerts)

Use alerts, such as Notes, sparingly. The blocks are designed to highlight "don't-miss-it" information.

The following versions of alerts are available. Replace the plain text with your own content.

> [!NOTE]
> Information the user should notice even if skimming.
> [!TIP]
> Optional information to help a user be more successful.
> [!IMPORTANT]
> Essential information required for user success.
> [!CAUTION]
> Negative potential consequences of an action.
> [!WARNING]
> Dangerous certain consequences of an action.

Note patterns.

For multi-line blockquote notes, use a greater-than (>) character in front of each line of the notes:

> This is a line in a blockquote.  It's ok for it to be very long; it will wrap.
> *  This is a list item.
> *  This is another list item.
>
> This is another line in a blockquote.

See Alerts (Note, Tip, Important, Caution, Warning) in the Docs Contributor Guide.

Images

Images should be stored in a media directory. Reference the image with a relative path relative to the Markdown file, using the following triple-colon image markup:

:::image type="content" source="./media/notes.png" alt-text="Describe what's shown in the image." lightbox="./media/notes.png":::

See Images in the Docs Contributor Guide.


Horizontal rules (divider lines)

To create a horizontal rule, use three hyphens alone on a line; ---. In this repo, these are rarely used; they are used between API function sections.

An equivalent Markdown tagging of * * * is used in a few files in this repo to demarcate the end of a set of tabs, to produce documentation for one programming language per tab.

edge-developer's People

Contributors

aarongustafson avatar abbycar avatar ashishnirvana1 avatar bwalderman avatar captainbrosset avatar codepo8 avatar david-risney avatar erdraud avatar ericlaw1979 avatar erikadoyle avatar gebansal avatar hxlnt avatar jasonstephen15 avatar jm-trd-ms avatar judahgabriel avatar libbymc avatar lilliankravitz avatar liminzhu avatar maggers avatar mattwojo avatar nschonni avatar pagoe-msft avatar peiche-jessica avatar pelavall avatar pkellner avatar reezaali avatar scottlow avatar shahina-jindal avatar vchapel avatar zoherghadyali 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.