# vsweb-docs

**Repository Path**: mirrors_aspnet/vsweb-docs

## Basic Information

- **Project Name**: vsweb-docs
- **Description**: Showcase for Visual Studio web features
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2025-11-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Visual Studio features for web developers

[![Build status](https://ci.appveyor.com/api/projects/status/3s1bavm412p4bwp6?svg=true)](https://ci.appveyor.com/project/madskristensen/vsweb-docs)

[![Deploy to Azure](http://azuredeploy.net/deploybutton.png)](https://azuredeploy.net/)

Website: [vsweb.azurewebsites.net/](http://vsweb.azurewebsites.net/)

### Features

- Uses CommonMark for rendering Markdown
- Uses the folder structure to create the menu
- Convention based file/folder structure
- Each page has a link to `Edit this page on GitHub`
- Everything is configurable from `web.config`
- Semantic URLs
- Each `.md` file can contain configuration
- AppVeyor integration
	- Automatically validates any pull request
	- Checks for missing metadata
- Theming support
- Support for IE9 and all modern browsers
- Responsive design to support all device types
- Best-in-class performance (Page Speed, YSlow)
- Best-in-class accessibility (WGAC, Section 508)
- Search engine optimization
  - HTML 5 microdata
  - robots.txt
  - Sitemap.xml
  - Semantic markup
- Social integration
  - Twitter cards support
  - OpenGraph support
  - Pinterest support
- Environment integration
  - IE9+ pinned sites suppport
  - Windows live tile support
  - iOS icon support
  - Android icon support
  - Firefox web manifest support

### Getting started

The website itself is really simple. It consists of a single
`index.cshtml` file. The entire site is built up around Markdown (`.md`) files
located inside the `pages` directory by default.

If need to deploy to the IIS, need to install the
<http://www.iis.net/downloads/microsoft/url-rewrite>

#### Folder structure

The folder structure determines how the menu is constructed as well as the
URLs to each page.

![Folder structure](https://raw.githubusercontent.com/madskristensen/MarkSite/master/art/folder-structure.png)

Each folder MUST have a file called `index.md` with the exception of folders starting
with an underscore (example: `/pages/_images/`).

#### Metadata

Each `.md` file has a bit of metadata at the top that allows you to customize
various aspects of the file.

```HTML
<properties
	pageTitle="FTP"
	description="bla bla bla"
	slug="ftp"
    order="300"
	keywords="ftp, deploy"
/>

My markdown content goes here
```

- __pageTitle__: The title of each page. Required
- __description__: The description of each page. Required
- __slug__: A Slug is what the URL should be. Must be lower cased. Required
- __order__: Determins the sort order of the page in the menu. Optional
- __keywords__: A comma separated list of keywords. 3 or more required

#### Screenshots/animated GIFs

To maintain a consistent look to all the screenshots/animated GIFs,
please adhere to these Visual Studio settings:

__Font__: 12pt Consolas  
__Theme__: Light

Also, please make sure to have a ~5 pixel padding when making an 
animated GIF from one of the editors, so the things you
show aren't located all the way at the edges of the
image, but about 5 pixels from the top and left.

The padding rule only applies to screenshots/animated GIFs taken
inside the editors.

The width of any screenshot/animated GIF, make sure to keep them at
a maximum of 600 pixels wide.

#### Validation

To help make sure that each pull request meets the requirements of the metadata,
the validator helps guide the contributors to write valid `.md` files for 
the MarkSite instance.

When using AppVeyor, each pull request is automatically being built and the 
validator will automatically fail the build in case the pull request isn't
satisfying the validator.