Interop Linter Docs

This is a documentation repository for Interop Linter, written for Documentation Portal, using docsify.

You can find out what docsify or markdown extensions are supported here.

The repository is currently in active development and contents will change rapidly.

File Structure

All rule files should live within the /rules folder. Each main section should be a separate markdown file by itself. If you have added a new main section, you should also update _sidebar.md so that it will show up when the webpage is rendered.

All non-markdown files (i.e. images and sample code files) should live within the assets subfolder.

Running Locally

Setting Up

• Install docsify cli npm -g install docsify-cli
• Download this repository via git clone
• Run docsify serve .

Syntax Highlighting

The repository has been pre-configured to pull in the default Developer Portal's styling for Documentations. (See index.html)

Web Hosting

By default, once you commit and push any changes into github, the contents will be updated automatically.

Contributing

Please fork the repository, make your changes and submit a Pull Request.