forked from RichardLitt/open-source-protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
params.json
1 lines (1 loc) · 2 KB
/
params.json
1
{"name":"Open-source-protocol","tagline":"Open up web development","body":"# Open Source Metatags\r\n\r\n###About\r\n\r\nThe Open Source Metatag is a way of telling developers where to access the source code for your website, if the source code is hosted in an open source repository. \r\n\r\nTo include an open source metatag in your website, simply add `<meta />` tags for the following properties:\r\n\r\n* `os:src` - This shows the repository web page, for instance on GitHub, Bitbucket, or Sourceforge.\r\n* `os:git` - This is the git repository that they should fork or clone. \r\n\r\nThis is not a place to link to code that is described on your website; rather, this is for the code _for the actual website_. That way, if anyone reading your website sees an error - a spelling mistake, broken CSS, etc - or something they want to examine - a cool paralax library, etc - they can quickly see the source code. \r\n\r\n###Example\r\n\r\n```html\r\n<meta property=\"os:src\" content=\"https://github.com/RichardLitt/open-source-metatags\" />\r\n<meta property=\"os:git\" content=\"git@github.com:RichardLitt/open-source-metatags.git\" />\r\n```\r\n\r\n###Optional tags\r\n\r\nOther tags that can be used:\r\n\r\n* `os:issue` - This links to a place to file issues for the website. Example: `<meta property=\"os:issue\" content=\"https://github.com/RichardLitt/open-source-metatags/issues\" />` \r\n\r\n###Shields\r\n\r\nFor use in the repository, to show your compliance and spread the word:\r\n\r\n![passing](https://img.shields.io/badge/OSMT-passing-green.svg) https://img.shields.io/badge/OSMT-passing-green.svg \r\n![failing](https://img.shields.io/badge/OSMT-failing-red.svg) https://img.shields.io/badge/OSMT-failing-red.svg\r\n\r\n###Contribute\r\n\r\nThis is a work in progress. Please open an [issue](https://github.com/RichardLitt/open-source-metatags/issues) to discuss how the Open Source Metatags can be improved. \r\n","google":"UA-4124866-28","note":"Don't delete this file! It's used internally to help with page regeneration."}