.
├── BLANK_README.md
├── MAIN-README.md
├── README.md
├── Standard-Project-README.md
├── alt-README.md
├── contributing-template.md
├── directory.html
├── filled-out-readme.md
├── html-versions
│ ├── BLANK_README.html
│ ├── MAIN-README.html
│ ├── README.html
│ ├── Standard-Project-README.html
│ ├── alt-README.html
│ ├── contributing-template.html
│ ├── filled-out-readme.html
│ ├── issue-template.html
│ ├── markdown-snippets
│ │ ├── Footer
│ │ │ ├── footnotes.html
│ │ │ │
│ │ │ └── social-links.html
│ │ ├── Header
│ │ │ ├── navigation-bar-1.html
│ │ │ │
│ │ │ └── table-of-content.html
│ │ ├── License-badges
│ │ │ ├── Apache_2.0.html
│ │ │ ├── Attribution_License_(BY).html
│ │ │ ├── BSD_2-clause_license.html
│ │ │ ├── BSD_3-clause_license.html
│ │ │ ├── GNU_GPL_v2.html
│ │ │ ├── GNU_GPL_v3.html
│ │ │ ├── MIT.html
│ │ │ ├── Mozilla_Public_License_2.0.html
│ │ │ ├── The_Unlicense.html
│ │ │ └── right.html
│ │ ├── README.html
│ │ ├── emojis
│ │ │ ├── emojis.html
│ │ │ └── right.html
│ │ │
│ │ └── xtrasInline-html
│ │ ├── keyboard.html
│ │ │
│ │ ├── superscript.html
│ │ └── top-right.html
│ ├── notes-template.html
│ ├── readme-alt-2.html
│ └── right.html
├── images
│ ├── logo.png
│ │
│ └── screenshot.png
├── index.html
├── issue-template.md
├── left.html
├── markdown-snippets
│ ├── Footer
│ │ ├── footnotes.md
│ │ │
│ │ └── social-links.md
│ ├── Header
│ │ ├── navigation-bar-1.md
│ │ │
│ │ └── table-of-content.md
│ ├── License-badges
│ │ ├── Apache_2.0.md
│ │ ├── Attribution_License_(BY).md
│ │ ├── BSD_2-clause_license.md
│ │ ├── BSD_3-clause_license.md
│ │ ├── GNU_GPL_v2.md
│ │ ├── GNU_GPL_v3.md
│ │ ├── MIT.md
│ │ ├── Mozilla_Public_License_2.0.md
│ │ ├── The_Unlicense.md
│ │ └── right.html
│ ├── README.md
│ ├── emojis
│ │ ├── emojis.md
│ │ └── right.html
│ │
│ └── xtrasInline-html
│ ├── keyboard.md
│ │
│ ├── superscript.md
│ └── top-right.md
├── notes-template.md
├── readme-alt-2.md
│
└── tree.md
14 directories, 77 files
TOC About ● Features ● How It Works ● Installation ● Development ● Contact
A 1-5 sentence summary of what the app is. 1-3 sentences ideal. Markdown tip: Add two spaces at the end of a line to create a line break.
##Try the Demo! [Live Website]
● See Website ● (Inspired by app name)
Describe overview of app, themes and philosophy, inspiration, audience, or whatever... 1-2 paragraphs
- Key action word a feature here.
- Emphasize action for this feature.
- Feature 3 highlights this benefit.
##For the Future
An optional brief note describing scheduling or other planning details.
- Major (high priority) A major feature
- Major A major feature
- Minor (low priority) A minor feature
- Maybe Undecided ideas or brainstorming
##1. Step One
- To do a thing, follow this step.
- *TIP This is a helpful tip.*
- *NOTE This is note about something.*
- *WARNING! This is a warning!*
Optional Special Section! For any additional asides. Maybe illustrating a specific example, a table of information, a code snippet, or 'fun facts' or quotes!
- A list
- could be
- nice too
Header A Header B A B
##How to Use Feature ABC Repeat the pattern.
##Troubleshooting Z Repeat the pattern.
- Create a new postgres database and owner.
- Create a
.envfile matching the.env.examplefile and your new postgres information. - Migrate the database with
npx sequelize-cli db:migrate. - Seed the migration with
npx sequelize-cli db:seed:all. - Run locally with
npm start.
##Get started on Heroku - Account, Database, Config Vars
- Install the Heroku CLI, if you haven't done so already.
- Create a free Heroku account.
- Login and create a new Heroku app.
- Navigate to the Resources tab an set up a 'Heroku Postgres' database for the app.
- Select the 'Hobby Dev - Free' plan.
- Navigate to the Settings tab. Click 'Reveal Config Vars'. Set the environment variables needed to run the app.
- NOTE NEVER check in
.envfiles or any private keys. Environment variables set in an.envfile won't work in Heroku anyway. - NOTE See the
DATABASE_URLis already set. This is done when the Heroku Postgres database was set up. Therefore,DB_USERNAME,DB_PASSWORD, andDB_DATABASEarent' required.
##Configure the app to use the Heroku Postgres database
There are two ways to configure the production environment:
- With dotenv and a
.sequelizercfile that points to aconfig/database.jsfile. - The Sequelize CLI's auto-generated
config.jsonfile.
With .sequelizerc and dotenv
Update the config/database.js file with a production key like so.
// config/database.js
// ...
module.exports = {
development: {
// ...
},
production: {
use_env_variable: "DATABASE_URL",
dialect: "postgres",
dialectOptions: { ssl: true },
seederStorage: "sequelize",
},
};With Sequelize CLI's config.json
Change the production entry to look like this:
"production": {
"dialect": "postgres",
"seederStorage": "sequelize",
"use_env_variable": "DATABASE_URL"
}- In the root of the app's repo directory, log into Heroku with
heroku login. - Add a new remote to GitHub configuration with
heroku git:remote -a <<app-name-here>>. - Add all changes with
git add .. - Commit changes with
git commit -m "<<Add message here>>". (Optionally,git commit -amAdds and commits in one command.) - Push changes to Heroku with
git push Heroku. - You should see a successful build image.
remote: -----> Launching...
remote: Released v5
remote: https://«your-app-name».herokuapp.com/ deployed to Heroku
remote:
remote: Verifying deploy... done.
To https://git.heroku.com/«app-name-here».git- To migrate your Heroku Postgres database, run the migration command prefaced with
heroku runinside the repo.
heroku run npx sequelize-cli db:migrate- To seed, preface the seed command with
heroku runas well.
heroku run npx sequelize-cli db:seed:all- To roll back, instead of dropping the database, first try to migrate down and up (shown below). If this doesn't work, reset the entire database by removing and adding the 'Heroku Postgres' add-on again, then migrating and seeding as the first time.
heroku run npx sequelize-cli db:seed:undo:all
heroku run npx sequelize-cli db:migrate:undo:all
heroku run npx sequelize-cli db:migrate
heroku run npx sequelize-cli db:seed:all
DEV TOC Technologies ● Concept ● Models ● Routes ● Wireframes ● Code Highlights ● Dev Snapshots
[See full dev notes HERE] The full notes on this project's development are kept in a separate document linked above. It details the technical aspects of this project's development. A few sample snapshots are below from the development process.
Thank you very much for your interest in this project. Feel free to reach out to provide feedback, bug reports, or anything else :) .
)
(Full-stack software developer)
gitignore-templates/
We’d love you to help us improve this project. To help us keep this collection high quality, we request that contributions adhere to the following guidelines.
-
Provide a link to the application or project’s homepage. Unless it’s extremely popular, there’s a chance the maintainers don’t know about or use the language, framework, editor, app, or project your change applies to.
-
Provide links to documentation supporting the change you’re making. Current, canonical documentation mentioning the files being ignored is best. If documentation isn’t available to support your change, do the best you can to explain what the files being ignored are for.
-
Explain why you’re making a change. Even if it seems self-evident, please take a sentence or two to tell us why your change or addition should happen. It’s especially helpful to articulate why this change applies to everyone who works with the applicable technology, rather than just you or your team.
-
Please consider the scope of your change. If your change specific to a certain language or framework, then make sure the change is made to the template for that language or framework, rather than to the template for an editor, tool, or operating system.
-
Please only modify one template per pull request. This helps keep pull requests and feedback focused on a specific project or technology.
In general, the more you can do to help us understand the change you’re making, the more likely we’ll be to accept your contribution quickly.
If a template is mostly a list of files installed by a particular version of
some software (e.g. a PHP framework) then it's brittle and probably no more
helpful than a simple ls. If it's not possible to curate a small set of
useful rules, then the template might not be a good fit for this collection.
Please also understand that we can’t list every tool that ever existed. Our aim is to curate a collection of the most common and helpful templates, not to make sure we cover every project possible. If we choose not to include your language, tool, or project, it’s not because it’s not awesome.
gitignore-templates/Global/
This directory contains globally useful gitignores, e.g. OS-specific and editor specific.
For more on global gitignores: https://help.github.com/en/github/using-git/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer
And a good blog post about 'em: http://augustl.com/blog/2009/global_gitignores
gitignore-templates/
This is GitHub’s collection of .gitignore file templates.
We use this list to populate the .gitignore template choosers available
in the GitHub.com interface when creating new repositories and files.
For more information about how .gitignore files work, and how to use them,
the following resources are a great place to start:
- The Ignoring Files chapter of the Pro Git book.
- The Ignoring Files article on the GitHub Help site.
- The gitignore(5) manual page.
We support a collection of templates, organized in this way:
- the root folder contains templates in common use, to help people get started with popular programming languages and technologies. These define a meaningful set of rules to help get started, and ensure you are not committing unimportant files into your repository
Globalcontains templates for various editors, tools and operating systems that can be used in different situations. It is recommended that you either add these to your global template or merge these rules into your project-specific templates if you want to use them permanently.communitycontains specialized templates for other popular languages, tools and project, which don't currently belong in the mainstream templates. These should be added to your project-specific templates when you decide to adopt the framework or tool.
A template should contain a set of rules to help Git repositories work with a specific programming language, framework, tool or environment.
If it's not possible to curate a small set of useful rules for this situation, then the template is not a good fit for this collection.
If a template is mostly a list of files installed by a particular version of
some software (e.g. a PHP framework), it could live under the community
directory. See versioned templates for more details.
If you have a small set of rules, or want to support a technology that is not widely in use, and still believe this will be helpful to others, please read the section about specialized templates for more details.
Include details when opening pull request if the template is important and visible. We may not accept it immediately, but we can promote it to the root at a later date based on interest.
Please also understand that we can’t list every tool that ever existed. Our aim is to curate a collection of the most common and helpful templates, not to make sure we cover every project possible. If we choose not to include your language, tool, or project, it’s not because it’s not awesome.
We’d love for you to help us improve this project. To help us keep this collection high quality, we request that contributions adhere to the following guidelines.
-
Provide a link to the application or project’s homepage. Unless it’s extremely popular, there’s a chance the maintainers don’t know about or use the language, framework, editor, app, or project your change applies to.
-
Provide links to documentation supporting the change you’re making. Current, canonical documentation mentioning the files being ignored is best. If documentation isn’t available to support your change, do the best you can to explain what the files being ignored are for.
-
Explain why you’re making a change. Even if it seems self-evident, please take a sentence or two to tell us why your change or addition should happen. It’s especially helpful to articulate why this change applies to everyone who works with the applicable technology, rather than just you or your team.
-
Please consider the scope of your change. If your change is specific to a certain language or framework, then make sure the change is made to the template for that language or framework, rather than to the template for an editor, tool, or operating system.
-
Please only modify one template per pull request. This helps keep pull requests and feedback focused on a specific project or technology.
In general, the more you can do to help us understand the change you’re making, the more likely we’ll be to accept your contribution quickly.
Some templates can change greatly between versions, and if you wish to contribute to this repository we need to follow this specific flow:
- the template at the root should be the current supported version
- the template at the root should not have a version in the filename (i.e. "evergreen")
- previous versions of templates should live under
community/ - previous versions of the template should embed the version in the filename, for readability
This helps ensure users get the latest version (because they'll use whatever is at the root) but helps maintainers support older versions still in the wild.
If you have a template that you would like to contribute, but it isn't quite
mainstream, please consider adding this to the community directory under a
folder that best suits where it belongs.
The rules in your specialized template should be specific to the framework or tool, and any additional templates should be mentioned in a comment in the header of the template.
For example, this template might live at community/DotNet/InforCRM.gitignore:
# gitignore template for InforCRM (formerly SalesLogix)
# website: https://www.infor.com/product-summary/cx/infor-crm/
#
# Recommended: VisualStudio.gitignore
# Ignore model files that are auto-generated
ModelIndex.xml
ExportedFiles.xml
# Ignore deployment files
[Mm]odel/[Dd]eployment
# Force include portal SupportFiles
!Model/Portal/*/SupportFiles/[Bb]in/
!Model/Portal/PortalTemplates/*/SupportFiles/[Bb]in
Here’s how we suggest you go about proposing a change to this project:
- Fork this project to your account.
- Create a branch for the change you intend to make.
- Make your changes to your fork.
- Send a pull request from your fork’s branch to our
masterbranch.
Using the web-based interface to make changes is fine too, and will help you by automatically forking the project and prompting to send a pull request too.
markdown-components/
title: Buttons - MDN Minimalist keywords: buttons, button styles, mdn minimalist, mdn, sass, library description: Example style and use of the button elements
- Ghost button
- Primary button
- Danger button
- Positive button
- Inactive button
- Minimal button
- Light button
- Icon button
- Button variants
- Ghost Button
- Primary Button
- Danger Button
- Positive Button
- Inactive Button
- {{< icon-button-left >}}
- {{< icon-button-right >}}
- Primary Outline Button
- Minimal Button
-
Light Button{.button-gallery}
title: Buttons - Ghost button - MDN Minimalist keywords: buttons, button styles, mdn minimalist, mdn, sass, library description: Example style and use of the ghost button element
The ghost button is used when a button element is required semantically, but should visually look like a anchor link.
Ghost Button
<button class="ghost">Ghost Button</button>title: Buttons - Icon button - MDN Minimalist keywords: buttons, button styles, mdn minimalist, mdn, sass, library description: Example style and use of the icon button element
When you need a button that will also contain an icon such as the sign-in buttons, this is the component to use. As can be seen in the code example, the icon SVG is embedded into the button element. This is to ensure that we can style the icon appropriately for the various interaction states.
<button class="button icon-button">
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 500 500"
aria-hidden="true"
role="presentation"
>
<path
class="cls-1"
d="M250 6.39C112.07 6.39.23 118.21.23 256.17c0 110.35 71.56 204 170.81 237 12.48 2.31 17.06-5.42 17.06-12 0-6-.23-25.63-.34-46.5-69.48 15.11-84.15-29.47-84.15-29.47-11.36-28.87-27.73-36.55-27.73-36.55-22.66-15.5 1.71-15.18 1.71-15.18 25.08 1.76 38.29 25.74 38.29 25.74 22.27 38.18 58.43 27.14 72.68 20.76 2.24-16.14 8.72-27.16 15.86-33.4-55.48-6.31-113.8-27.73-113.8-123.44 0-27.27 9.76-49.55 25.74-67-2.6-6.3-11.15-31.7 2.42-66.11 0 0 21-6.7 68.7 25.61a236.78 236.78 0 01125.09 0c47.68-32.36 68.62-25.63 68.62-25.63 13.6 34.41 5.05 59.81 2.45 66.11 16 17.49 25.71 39.77 25.71 67 0 95.94-58.43 117.06-114 123.24 9 7.75 16.94 22.95 16.94 46.26 0 33.42-.29 60.31-.29 68.54 0 6.65 4.5 14.44 17.15 12 99.2-33.07 170.67-126.66 170.67-237C499.77 118.21 387.94 6.39 250 6.39z"
/>
<path
class="cls-2"
d="M94.83 365c-.55 1.25-2.51 1.62-4.28.77s-2.83-2.51-2.24-3.76 2.49-1.63 4.3-.78 2.84 2.53 2.22 3.77zm-3.08-2.28M105 376.3c-1.19 1.1-3.53.59-5.1-1.16s-1.94-4.07-.74-5.19 3.49-.58 5.13 1.16 2 4.07.71 5.19zm-2.39-2.56M114.79 390.68c-1.53 1.07-4 .07-5.58-2.15s-1.53-4.89 0-5.95 4-.11 5.58 2.09 1.53 4.93 0 6zm0 0M128.29 404.58c-1.37 1.51-4.29 1.1-6.42-1s-2.79-4.87-1.42-6.38 4.32-1.08 6.47 1 2.82 4.89 1.37 6.38zm0 0M146.9 412.65c-.61 2-3.41 2.84-6.24 2s-4.68-3.14-4.11-5.12 3.41-2.89 6.26-2 4.67 3.13 4.09 5.12zm0 0M167.34 414.15c.07 2.06-2.33 3.76-5.3 3.8s-5.4-1.6-5.44-3.63 2.35-3.76 5.34-3.82 5.4 1.6 5.4 3.65zm0 0M186.36 410.91c.36 2-1.71 4.07-4.66 4.62s-5.58-.71-5.95-2.7 1.74-4.12 4.64-4.66 5.6.7 6 2.74zm0 0"
/>
</svg>
Sign in with Github
</button>If you need the icon to be aligned on the right-hand side of the button add the SVG after the button's text content and use the right class.
<button class="button icon-button right">
Sign up now
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 26 32"
aria-hidden="true"
role="presentation"
>
<path
d="M26.3 17.1c0 .6-.2 1.2-.7 1.6L14 30.4c-.4.4-1 .7-1.6.7s-1.2-.2-1.6-.7l-1.3-1.3c-.4-.4-.7-1-.7-1.6s.2-1.2.7-1.6l5.2-5.2H2.1C.8 20.7 0 19.6 0 18.4V16c0-1.2.8-2.3 2.1-2.3h12.6L9.4 8.5c-.9-.9-.9-2.3 0-3.2L10.7 4c.4-.4 1-.7 1.6-.7s1.2.2 1.6.7l11.6 11.6c.6.3.8.9.8 1.5z"
/>
</svg>
</button>title: Buttons - Inactive button - MDN Minimalist keywords: buttons, button styles, mdn minimalist, mdn, sass, library description: Example style and use of the inactive button element
As the name suggests, this is the style used when a button is inactive.
Inactive Button
<button class="button inactive">Inactive Button</button>title: callout - MDN Minimalist keywords: callout, callout component, mdn minimalist, mdn, sass, library description: Example style and use of the callout component
The callout is commonly used within content in the learning area to direct users to other pages that might be of interest. A callout commonly consists of a heading, short lead paragrap and a call to action.
We have put together a course that includes all the essential information you need to work towards your goal.
<div class="callout">
<h4 id="Looking_to_become_a_front-end_web_developer">
Looking to become a front-end web developer?
</h4>
<p>
We have put together a course that includes all the essential information
you need to work towards your goal.
</p>
<p>
<a class="button" href="/docs/Learn/Front-end_web_developer">Get started</a>
</p>
</div>title: Color Palette - MDN Minimalist keywords: color, color palette, mdn minimalist, mdn, sass, library description: The MDN Web Docs color palette
The below table provide guidelines on the usage of the various color variables. More details about color contrast can be seen inside Figma.
| Text | Primary CTA | Icons | Borders | Backgrounds |
|---|---|---|---|---|
| 900, 800, 700 | 600 | 500 | 400, 300, 200 | 100, white |
$mdn-neutral100$mdn-neutral200$mdn-neutral300$mdn-neutral400$mdn-neutral500$mdn-neutral600$mdn-neutral700$mdn-neutral800$mdn-neutral900
$mdn-blue100$mdn-blue200$mdn-blue300$mdn-blue400$mdn-blue500$mdn-blue600$mdn-blue700$mdn-blue800$mdn-blue900
$mdn-green100$mdn-green200$mdn-green300$mdn-green400$mdn-green500$mdn-green600$mdn-green700$mdn-green800$mdn-green900
$mdn-yellow100$mdn-yellow200$mdn-yellow300$mdn-yellow400$mdn-yellow500$mdn-yellow600$mdn-yellow700$mdn-yellow800$mdn-yellow900
$mdn-red100$mdn-red200$mdn-red300$mdn-red400$mdn-red500$mdn-red600$mdn-red700$mdn-red800$mdn-red900
Orange is a problematic color in terms of color contrast both when used as a foreground and background color. Be careful when using these colors. It should generally be used as an accent color.
$mdn-orange100$mdn-orange200$mdn-orange300$mdn-orange400$mdn-orange500$mdn-orange600$mdn-orange700$mdn-orange800$mdn-orange900
title: Tables - MDN Minimalist keywords: tables, table element, mdn minimalist, mdn, sass, library description: The MDN Web Docs table element styles
This is the most commonly used table style across MDN Web Docs. It is achieved by adding the standard-table class to the table element.
Note: Notice the use of the
theadelement as well as thescopeattribute on thethelements. This is critical to set correctly to ensure our table data is exposed correctly to assistive technologies.
| Attribute | Description |
|---|---|
autocorrect |
A string indicating whether or not autocorrect is on or off. Safari only. |
incremental |
Whether or not to send repeated search events to allow updating live search results while the user is still editing the value of the field. WebKit and Blink only (Safari, Chrome, Opera, etc.). |
webkitdirectory |
A Boolean indicating whether or not to only allow the user to choose a directory (or directories, if multiple is also present) |
<table class="standard-table">
<thead>
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code><a href="#autocorrect">autocorrect</a></code>
</td>
<td>
A string indicating whether or not autocorrect is <code>on</code> or
<code>off</code>. <strong>Safari only.</strong>
</td>
</tr>
<tr>
<td>
<code><a href="#incremental">incremental</a></code>
</td>
<td>
Whether or not to send repeated
<a
href="/en-US/docs/Web/API/HTMLInputElement/search_event"
title="search"
><code>search</code></a
>
events to allow updating live search results while the user is still
editing the value of the field.
<strong>WebKit and Blink only (Safari, Chrome, Opera, etc.).</strong>
</td>
</tr>
</tbody>
</table>Property tables is most commonly used for technical summaries such as the table seen here. The style is achieved by adding the class properties to the table element.
Note: Notice the use of the
thelements in each row as well as thescopeattribute. This is critical to set correctly to ensure our table data is exposed correctly to assistive technologies.
| Content categories | Flow content, phrasing content, embedded
content. If it has a controls
attribute: interactive content and palpable content. |
|---|---|
| Permitted content |
If the element has a Else: zero or more |
| Tag omission | None, both the starting and ending tag are mandatory. |
| Permitted parents | Any element that accepts embedded content. |
| Implicit ARIA role | No corresponding role |
| Permitted ARIA roles | application
|
| DOM interface | HTMLVideoElement
|
<table class="properties">
<tbody>
<tr>
<th scope="row">
<a
href="/en-US/docs/Web/Guide/HTML/Content_categories"
data-flaw="link5"
>Content categories</a
>
</th>
<td>
<a
href="/en-US/docs/Web/Guide/HTML/Content_categories#Flow_content"
data-flaw="link6"
>Flow content</a
>, phrasing content, embedded content. If it has a
<a href="/en-US/docs/Web/HTML/Element/video#attr-controls"
><code>controls</code></a
>
attribute: interactive content and palpable content.
</td>
</tr>
<tr>
<th scope="row">Tag omission</th>
<td>None, both the starting and ending tag are mandatory.</td>
</tr>
<tr>
<th scope="row">Permitted parents</th>
<td>Any element that accepts embedded content.</td>
</tr>
</tbody>
</table>title: blockquote - MDN Minimalist keywords: blockquote, mdn minimalist, mdn, sass, library description: Example style and use of the blockquote elements
Below is an example of a common use of the blockquote element and the style that will be applied.
The request was redirected to https://example.com/foo, which is disallowed for cross-origin requests that require preflight
<blockquote>
The request was redirected to https://example.com/foo, which is disallowed for
cross-origin requests that require preflight
</blockquote>title: Forms - Input - MDN Minimalist keywords: forms, input elements, mdn minimalist, mdn, sass, library description: The MDN Web Docs input element styles
With input fields, note that the label element is always associated with its input element via the for attribute.
<label for="name">A text input field</label>
<input type="text" id="name" name="name" />
<label for="password">A password field</label>
<input type="password" id="password" name="password" />
<label for="email">An email input field in invalid state</label>
<input type="email" id="email" name="email" placeholder="me@example.com" />title: Forms - Label - MDN Minimalist keywords: forms, label, mdn minimalist, mdn, sass, library description: The MDN Web Docs label element styles
label elements on MDN Web Docs are displayed as block level
elements by default.
<label>Default label</label>If you require an inline label element, add the
inline class to the relevant label element
<label class="inline">Inline label</label>title: Forms - Legend - MDN Minimalist keywords: forms, legend, mdn minimalist, mdn, sass, library description: The MDN Web Docs legend element styles
Default
legend
No additional styling is added to legend elements by default.
<fieldset class="bordered">
<legend>Default <code>legend</code></legend>
<p>
No additional styling is added to <code>legend</code> elements by default.
</p>
</fieldset>legend
For highlighted legend elements, use the highlighted
class on the legend element.
<fieldset class="bordered">
<legend class="highlighted">Highlighted <code>legend</code></legend>
<p>
For highlighted <code>legend</code> elements, use the
<code>highlighted</code> class on the <code>legend</code> element.
</p>
</fieldset>legend
For a non-highlighted but emphasized legend use the
emphasized class on the legend element.
<fieldset class="bordered">
<legend class="emphasized">Emphasized <code>legend</code></legend>
<p>
For a non-highlighted but emphasized <code>legend</code> use the
<code>emphasized</code> class on the <code>legend</code> element.
</p>
</fieldset>legend
You can use all legend styles with, or without, a bordered
fieldset
<fieldset>
<legend class="highlighted">Highlighted <code>legend</code></legend>
<p>
You can use all <code>legend</code> styles with, or without, a bordered
<code>fieldset</code>
</p>
</fieldset>Example: Visually hidden legend
In some instances one might, from a design perspective, wish to not visually show the legend. In those instances it is best to visually hide it so that it still available to screen reader users.
Visually hidden legend elementTo hide a legend, but not negatively impact accessibility, use the
visually-hidden utility class on the legend element.
For example, this fieldset contains a legend with the
text content of, "Visually hidden legend element"
<fieldset class="bordered">
<legend class="visually-hidden">Visually hidden legend element</legend>
<p>
To hide a <code>legend</code>, but not negatively impact accessibility, use
the <code>visually-hidden</code> utility class on the
<code>legend</code> element. For example, this
<code>fieldset</code> contains a <code>legend</code> with the text content
of, "Visually hidden legend element"
</p>
</fieldset>title: Buttons - Light button - MDN Minimalist keywords: buttons, button styles, mdn minimalist, mdn, sass, library description: Example style and use of the light button element
When using a button on a dark background opt for the light button variant.
<button class="button light">Light Button</button>title: Buttons - Minimal button - MDN Minimalist keywords: buttons, button styles, mdn minimalist, mdn, sass, library description: Example style and use of the minimal button element
In some instances the standard buttons might be simply to large. In those cases you can use the minimal button.
Minimal Button
<button class="button minimal">Minimal Button</button>title: Buttons - Positive button - MDN Minimalist keywords: buttons, button styles, mdn minimalist, mdn, sass, library description: Example style and use of the positive button element
For general form submission using the positive button.
Positive Button
<button class="button positive">Positive Button</button>title: Buttons - Primary button - MDN Minimalist keywords: buttons, button styles, mdn minimalist, mdn, sass, library description: Example style and use of the primary button element
The primary button is primarily used for call to action items.
Primary Button
<button class="button">Primary Button</button>title: Forms - Radio buttons - MDN Minimalist keywords: forms, radio buttons, mdn minimalist, mdn, sass, library description: The MDN Web Docs radio button element styles
Yup Nope
<label for="yes">
<input type="radio" id="yes" name="subscribe" value="yup" checked />
Yup
</label>title: Forms - Select - MDN Minimalist keywords: forms, select, mdn minimalist, mdn, sass, library description: The MDN Web Docs select element styles
Fruits Apple Strawberry Grapes
<label for="fruits">Fruits</label>
<select name="fruit" id="fruits">
<option value="apple">Apple</option>
<option value="strawberry" selected>Strawberry</option>
<option value="grapes">Grapes</option>
</select>title: Forms - Label - MDN Minimalist keywords: forms, label, mdn minimalist, mdn, sass, library description: The MDN Web Docs label element styles
When a field is in an invalid state, we can visually indicate this by adding the invalid class to the element.
<label for="email">An email input field in invalid state</label>
<input
type="email"
id="email"
name="email"
class="invalid"
placeholder="me@example.com"
/>To indicate that a field is in a valid state, we can visually indicate this by adding the valid class to the element.
<label for="url">An url input field in a valid state</label>
<input
type="url"
id="url"
name="url"
class="valid"
pattern="http[s]?://.*"
placeholder="https://www.duckduckgo.com"
/>title: Forms - Textarea - MDN Minimalist keywords: forms, textarea, mdn minimalist, mdn, sass, library description: The MDN Web Docs textarea element styles
A
textarea for comments
<textarea id="comment"></textarea>
<label for="comment">A <code>textarea</code> for comments</label>
<textarea id="comment"></textarea>markdown-snippets/emojis/
 :bowtie: |
😄 :smile: |
😆 :laughing: |
|---|---|---|
😊 :blush: |
😃 :smiley: |
:relaxed: |
😏 :smirk: |
😍 :heart_eyes: |
😘 :kissing_heart: |
😚 :kissing_closed_eyes: |
😳 :flushed: |
😌 :relieved: |
😆 :satisfied: |
😁 :grin: |
😉 :wink: |
😜 :stuck_out_tongue_winking_eye: |
😝 :stuck_out_tongue_closed_eyes: |
😀 :grinning: |
😗 :kissing: |
😙 :kissing_smiling_eyes: |
😛 :stuck_out_tongue: |
😴 :sleeping: |
😟 :worried: |
😦 :frowning: |
😧 :anguished: |
😮 :open_mouth: |
😬 :grimacing: |
😕 :confused: |
😯 :hushed: |
😑 :expressionless: |
😒 :unamused: |
😅 :sweat_smile: |
😓 :sweat: |
😥 :disappointed_relieved: |
😩 :weary: |
😔 :pensive: |
😞 :disappointed: |
😖 :confounded: |
😨 :fearful: |
😰 :cold_sweat: |
😣 :persevere: |
😢 :cry: |
😭 :sob: |
😂 :joy: |
😲 :astonished: |
😱 :scream: |
 :neckbeard: |
😫 :tired_face: |
😠 :angry: |
😡 :rage: |
😤 :triumph: |
😪 :sleepy: |
😋 :yum: |
😷 :mask: |
😎 :sunglasses: |
😵 :dizzy_face: |
👿 :imp: |
😈 :smiling_imp: |
😐 :neutral_face: |
😶 :no_mouth: |
😇 :innocent: |
👽 :alien: |
💛 :yellow_heart: |
💙 :blue_heart: |
💜 :purple_heart: |
❤️ :heart: |
💚 :green_heart: |
💔 :broken_heart: |
💓 :heartbeat: |
💗 :heartpulse: |
💕 :two_hearts: |
💞 :revolving_hearts: |
💘 :cupid: |
💖 :sparkling_heart: |
✨ :sparkles: |
⭐ :star: |
🌟 :star2: |
💫 :dizzy: |
💥 :boom: |
💥 :collision: |
💢 :anger: |
❗ :exclamation: |
❓ :question: |
❕ :grey_exclamation: |
❔ :grey_question: |
💤 :zzz: |
💨 :dash: |
💦 :sweat_drops: |
🎶 :notes: |
🎵 :musical_note: |
🔥 :fire: |
💩 :hankey: |
💩 :poop: |
💩 :shit: |
👍 :+1: |
👍 :thumbsup: |
👎 :-1: |
👎 :thumbsdown: |
👌 :ok_hand: |
👊 :punch: |
👊 :facepunch: |
✊ :fist: |
✌️ :v: |
👋 :wave: |
✋ :hand: |
✋ :raised_hand: |
👐 :open_hands: |
☝️ :point_up: |
👇 :point_down: |
👈 :point_left: |
👉 :point_right: |
🙌 :raised_hands: |
🙏 :pray: |
👆 :point_up_2: |
👏 :clap: |
💪 :muscle: |
🤘 :metal: |
🖕 :fu: |
🚶 :walking: |
🏃 :runner: |
🏃 :running: |
👫 :couple: |
👪 :family: |
👬 :two_men_holding_hands: |
👭 :two_women_holding_hands: |
💃 :dancer: |
👯 :dancers: |
🙆♀️ :ok_woman: |
🙅 :no_good: |
💁 :information_desk_person: |
🙋 :raising_hand: |
👰♀️ :bride_with_veil: |
:person_with_pouting_face: :person_with_pouting_face: |
:person_frowning: :person_frowning: |
🙇 :bow: |
💏 :couplekiss: |
💑 :couple_with_heart: |
💆 :massage: |
💇 :haircut: |
💅 :nail_care: |
👦 :boy: |
👧 :girl: |
👩 :woman: |
👨 :man: |
👶 :baby: |
👵 :older_woman: |
👴 :older_man: |
:person_with_blond_hair: :person_with_blond_hair: |
👲 :man_with_gua_pi_mao: |
👳♂️ :man_with_turban: |
👷 :construction_worker: |
👮 :cop: |
👼 :angel: |
👸 :princess: |
😺 :smiley_cat: |
😸 :smile_cat: |
😻 :heart_eyes_cat: |
😽 :kissing_cat: |
😼 :smirk_cat: |
🙀 :scream_cat: |
😿 :crying_cat_face: |
😹 :joy_cat: |
😾 :pouting_cat: |
👹 :japanese_ogre: |
👺 :japanese_goblin: |
🙈 :see_no_evil: |
🙉 :hear_no_evil: |
🙊 :speak_no_evil: |
💂♂️ :guardsman: |
💀 :skull: |
🐾 :feet: |
👄 :lips: |
💋 :kiss: |
💧 :droplet: |
👂 :ear: |
👀 :eyes: |
👃 :nose: |
👅 :tongue: |
💌 :love_letter: |
👤 :bust_in_silhouette: |
👥 :busts_in_silhouette: |
💬 :speech_balloon: |
💭 :thought_balloon: |
 :feelsgood: |
 :finnadie: |
 :goberserk: |
 :godmode: |
 :hurtrealbad: |
 :rage1: |
 :rage2: |
 :rage3: |
 :rage4: |
 :suspect: |
 :trollface: |
☀️ :sunny: |
☔ :umbrella: |
☁️ :cloud: |
|---|---|---|
❄️ :snowflake: |
⛄ :snowman: |
⚡ :zap: |
🌀 :cyclone: |
🌁 :foggy: |
🌊 :ocean: |
🐱 :cat: |
🐶 :dog: |
🐭 :mouse: |
🐹 :hamster: |
🐰 :rabbit: |
🐺 :wolf: |
🐸 :frog: |
🐯 :tiger: |
🐨 :koala: |
🐻 :bear: |
🐷 :pig: |
🐽 :pig_nose: |
🐮 :cow: |
🐗 :boar: |
🐵 :monkey_face: |
🐒 :monkey: |
🐴 :horse: |
🐎 :racehorse: |
🐫 :camel: |
🐑 :sheep: |
🐘 :elephant: |
🐼 :panda_face: |
🐍 :snake: |
🐦 :bird: |
🐤 :baby_chick: |
🐥 :hatched_chick: |
🐣 :hatching_chick: |
🐔 :chicken: |
🐧 :penguin: |
🐢 :turtle: |
🐛 :bug: |
🐝 :honeybee: |
🐜 :ant: |
🪲 :beetle: |
🐌 :snail: |
🐙 :octopus: |
🐠 :tropical_fish: |
🐟 :fish: |
🐳 :whale: |
🐋 :whale2: |
🐬 :dolphin: |
🐄 :cow2: |
🐏 :ram: |
🐀 :rat: |
🐃 :water_buffalo: |
🐅 :tiger2: |
🐇 :rabbit2: |
🐉 :dragon: |
🐐 :goat: |
🐓 :rooster: |
🐕 :dog2: |
🐖 :pig2: |
🐁 :mouse2: |
🐂 :ox: |
🐲 :dragon_face: |
🐡 :blowfish: |
🐊 :crocodile: |
🐪 :dromedary_camel: |
🐆 :leopard: |
🐈 :cat2: |
🐩 :poodle: |
🐾 :paw_prints: |
💐 :bouquet: |
🌸 :cherry_blossom: |
🌷 :tulip: |
🍀 :four_leaf_clover: |
🌹 :rose: |
🌻 :sunflower: |
🌺 :hibiscus: |
🍁 :maple_leaf: |
🍃 :leaves: |
🍂 :fallen_leaf: |
🌿 :herb: |
🍄 :mushroom: |
🌵 :cactus: |
🌴 :palm_tree: |
🌲 :evergreen_tree: |
🌳 :deciduous_tree: |
🌰 :chestnut: |
🌱 :seedling: |
🌼 :blossom: |
🌾 :ear_of_rice: |
🐚 :shell: |
🌐 :globe_with_meridians: |
🌞 :sun_with_face: |
🌝 :full_moon_with_face: |
🌚 :new_moon_with_face: |
🌑 :new_moon: |
🌒 :waxing_crescent_moon: |
🌓 :first_quarter_moon: |
🌔 :waxing_gibbous_moon: |
🌕 :full_moon: |
🌖 :waning_gibbous_moon: |
🌗 :last_quarter_moon: |
🌘 :waning_crescent_moon: |
🌜 :last_quarter_moon_with_face: |
🌛 :first_quarter_moon_with_face: |
🌔 :moon: |
🌍 :earth_africa: |
🌎 :earth_americas: |
🌏 :earth_asia: |
🌋 :volcano: |
🌌 :milky_way: |
⛅ :partly_sunny: |
 :octocat: |
:squirrel: :squirrel: |
🎍 :bamboo: |
💝 :gift_heart: |
🎎 :dolls: |
|---|---|---|
🎒 :school_satchel: |
🎓 :mortar_board: |
🎏 :flags: |
🎆 :fireworks: |
🎇 :sparkler: |
🎐 :wind_chime: |
🎑 :rice_scene: |
🎃 :jack_o_lantern: |
👻 :ghost: |
🎅 :santa: |
🎄 :christmas_tree: |
🎁 :gift: |
🔔 :bell: |
🔕 :no_bell: |
🎋 :tanabata_tree: |
🎉 :tada: |
🎊 :confetti_ball: |
🎈 :balloon: |
🔮 :crystal_ball: |
💿 :cd: |
📀 :dvd: |
💾 :floppy_disk: |
📷 :camera: |
📹 :video_camera: |
🎥 :movie_camera: |
💻 :computer: |
📺 :tv: |
📱 :iphone: |
☎️ :phone: |
☎️ :telephone: |
📞 :telephone_receiver: |
📟 :pager: |
📠 :fax: |
💽 :minidisc: |
📼 :vhs: |
🔉 :sound: |
🔈 :speaker: |
🔇 :mute: |
📢 :loudspeaker: |
📣 :mega: |
⌛ :hourglass: |
⏳ :hourglass_flowing_sand: |
⏰ :alarm_clock: |
⌚ :watch: |
📻 :radio: |
📡 :satellite: |
➿ :loop: |
🔍 :mag: |
🔎 :mag_right: |
🔓 :unlock: |
🔒 :lock: |
🔏 :lock_with_ink_pen: |
🔐 :closed_lock_with_key: |
🔑 :key: |
💡 :bulb: |
🔦 :flashlight: |
🔆 :high_brightness: |
🔅 :low_brightness: |
🔌 :electric_plug: |
🔋 :battery: |
📲 :calling: |
📧 :email: |
📫 :mailbox: |
📮 :postbox: |
🛀 :bath: |
🛁 :bathtub: |
🚿 :shower: |
🚽 :toilet: |
🔧 :wrench: |
🔩 :nut_and_bolt: |
🔨 :hammer: |
💺 :seat: |
💰 :moneybag: |
💴 :yen: |
💵 :dollar: |
💷 :pound: |
💶 :euro: |
💳 :credit_card: |
💸 :money_with_wings: |
📧 :e-mail: |
📥 :inbox_tray: |
📤 :outbox_tray: |
✉️ :envelope: |
📨 :incoming_envelope: |
📯 :postal_horn: |
📪 :mailbox_closed: |
📬 :mailbox_with_mail: |
📭 :mailbox_with_no_mail: |
🚪 :door: |
🚬 :smoking: |
💣 :bomb: |
🔫 :gun: |
🔪 :hocho: |
💊 :pill: |
💉 :syringe: |
📄 :page_facing_up: |
📃 :page_with_curl: |
📑 :bookmark_tabs: |
📊 :bar_chart: |
📈 :chart_with_upwards_trend: |
📉 :chart_with_downwards_trend: |
📜 :scroll: |
📋 :clipboard: |
📆 :calendar: |
📅 :date: |
📇 :card_index: |
📁 :file_folder: |
📂 :open_file_folder: |
✂️ :scissors: |
📌 :pushpin: |
📎 :paperclip: |
✒️ :black_nib: |
✏️ :pencil2: |
📏 :straight_ruler: |
📐 :triangular_ruler: |
📕 :closed_book: |
📗 :green_book: |
📘 :blue_book: |
📙 :orange_book: |
📓 :notebook: |
📔 :notebook_with_decorative_cover: |
📒 :ledger: |
📚 :books: |
🔖 :bookmark: |
📛 :name_badge: |
🔬 :microscope: |
🔭 :telescope: |
📰 :newspaper: |
🏈 :football: |
🏀 :basketball: |
⚽ :soccer: |
⚾ :baseball: |
🎾 :tennis: |
🎱 :8ball: |
🏉 :rugby_football: |
🎳 :bowling: |
⛳ :golf: |
🚵 :mountain_bicyclist: |
🚴 :bicyclist: |
🏇 :horse_racing: |
🏂 :snowboarder: |
🏊 :swimmer: |
🏄 :surfer: |
🎿 :ski: |
:spades: |
:hearts: |
:clubs: |
:diamonds: |
💎 :gem: |
💍 :ring: |
🏆 :trophy: |
🎼 :musical_score: |
🎹 :musical_keyboard: |
🎻 :violin: |
👾 :space_invader: |
🎮 :video_game: |
🃏 :black_joker: |
🎴 :flower_playing_cards: |
🎲 :game_die: |
🎯 :dart: |
🀄 :mahjong: |
🎬 :clapper: |
📝 :memo: |
📝 :pencil: |
📖 :book: |
🎨 :art: |
🎤 :microphone: |
🎧 :headphones: |
🎺 :trumpet: |
🎷 :saxophone: |
🎸 :guitar: |
👞 :shoe: |
👡 :sandal: |
👠 :high_heel: |
💄 :lipstick: |
👢 :boot: |
👕 :shirt: |
👕 :tshirt: |
👔 :necktie: |
👚 :womans_clothes: |
👗 :dress: |
🎽 :running_shirt_with_sash: |
👖 :jeans: |
👘 :kimono: |
👙 :bikini: |
🎀 :ribbon: |
🎩 :tophat: |
👑 :crown: |
👒 :womans_hat: |
👞 :mans_shoe: |
🌂 :closed_umbrella: |
💼 :briefcase: |
👜 :handbag: |
👝 :pouch: |
👛 :purse: |
👓 :eyeglasses: |
🎣 :fishing_pole_and_fish: |
☕ :coffee: |
🍵 :tea: |
🍶 :sake: |
🍼 :baby_bottle: |
🍺 :beer: |
🍻 :beers: |
🍸 :cocktail: |
🍹 :tropical_drink: |
🍷 :wine_glass: |
🍴 :fork_and_knife: |
🍕 :pizza: |
🍔 :hamburger: |
🍟 :fries: |
🍗 :poultry_leg: |
🍖 :meat_on_bone: |
🍝 :spaghetti: |
🍛 :curry: |
🍤 :fried_shrimp: |
🍱 :bento: |
🍣 :sushi: |
🍥 :fish_cake: |
🍙 :rice_ball: |
🍘 :rice_cracker: |
🍚 :rice: |
🍜 :ramen: |
🍲 :stew: |
🍢 :oden: |
🍡 :dango: |
🥚 :egg: |
🍞 :bread: |
🍩 :doughnut: |
🍮 :custard: |
🍦 :icecream: |
🍨 :ice_cream: |
🍧 :shaved_ice: |
🎂 :birthday: |
🍰 :cake: |
🍪 :cookie: |
🍫 :chocolate_bar: |
🍬 :candy: |
🍭 :lollipop: |
🍯 :honey_pot: |
🍎 :apple: |
🍏 :green_apple: |
🍊 :tangerine: |
🍋 :lemon: |
🍒 :cherries: |
🍇 :grapes: |
🍉 :watermelon: |
🍓 :strawberry: |
🍑 :peach: |
🍈 :melon: |
🍌 :banana: |
🍐 :pear: |
🍍 :pineapple: |
🍠 :sweet_potato: |
🍆 :eggplant: |
🍅 :tomato: |
🌽 :corn: |
🏠 :house: |
🏡 :house_with_garden: |
🏫 :school: |
|---|---|---|
🏢 :office: |
🏣 :post_office: |
🏥 :hospital: |
🏦 :bank: |
🏪 :convenience_store: |
🏩 :love_hotel: |
🏨 :hotel: |
💒 :wedding: |
⛪ :church: |
🏬 :department_store: |
🏤 :european_post_office: |
🌇 :city_sunrise: |
🌆 :city_sunset: |
🏯 :japanese_castle: |
🏰 :european_castle: |
⛺ :tent: |
🏭 :factory: |
🗼 :tokyo_tower: |
🗾 :japan: |
🗻 :mount_fuji: |
🌄 :sunrise_over_mountains: |
🌅 :sunrise: |
🌠 :stars: |
🗽 :statue_of_liberty: |
🌉 :bridge_at_night: |
🎠 :carousel_horse: |
🌈 :rainbow: |
🎡 :ferris_wheel: |
⛲ :fountain: |
🎢 :roller_coaster: |
🚢 :ship: |
🚤 :speedboat: |
⛵ :boat: |
⛵ :sailboat: |
🚣 :rowboat: |
⚓ :anchor: |
🚀 :rocket: |
:airplane: |
🚁 :helicopter: |
🚂 :steam_locomotive: |
🚊 :tram: |
🚞 :mountain_railway: |
🚲 :bike: |
🚡 :aerial_tramway: |
🚟 :suspension_railway: |
🚠 :mountain_cableway: |
🚜 :tractor: |
🚙 :blue_car: |
🚘 :oncoming_automobile: |
🚗 :car: |
🚗 :red_car: |
🚕 :taxi: |
🚖 :oncoming_taxi: |
🚛 :articulated_lorry: |
🚌 :bus: |
🚍 :oncoming_bus: |
🚨 :rotating_light: |
🚓 :police_car: |
🚔 :oncoming_police_car: |
🚒 :fire_engine: |
🚑 :ambulance: |
🚐 :minibus: |
🚚 :truck: |
🚋 :train: |
🚉 :station: |
🚆 :train2: |
🚅 :bullettrain_front: |
🚄 :bullettrain_side: |
🚈 :light_rail: |
🚝 :monorail: |
🚃 :railway_car: |
🚎 :trolleybus: |
🎫 :ticket: |
⛽ :fuelpump: |
🚦 :vertical_traffic_light: |
🚥 :traffic_light: |
:warning: |
🚧 :construction: |
🔰 :beginner: |
🏧 :atm: |
🎰 :slot_machine: |
🚏 :busstop: |
💈 :barber: |
♨️ :hotsprings: |
🏁 :checkered_flag: |
🎌 :crossed_flags: |
🏮 :izakaya_lantern: |
🗿 :moyai: |
🎪 :circus_tent: |
🎭 :performing_arts: |
📍 :round_pushpin: |
🚩 :triangular_flag_on_post: |
🇯🇵 :jp: |
🇰🇷 :kr: |
🇨🇳 :cn: |
🇺🇸 :us: |
🇫🇷 :fr: |
🇪🇸 :es: |
🇮🇹 :it: |
🇷🇺 :ru: |
🇬🇧 :gb: |
🇬🇧 :uk: |
🇩🇪 :de: |
1️⃣ :one: |
2️⃣ :two: |
3️⃣ :three: |
|---|---|---|
4️⃣ :four: |
5️⃣ :five: |
6️⃣ :six: |
7️⃣ :seven: |
8️⃣ :eight: |
9️⃣ :nine: |
🔟 :keycap_ten: |
🔢 :1234: |
0️⃣ :zero: |
#️⃣ :hash: |
🔣 :symbols: |
:arrow_backward: |
⬇️ :arrow_down: |
:arrow_forward: |
⬅️ :arrow_left: |
🔠 :capital_abcd: |
🔡 :abcd: |
🔤 :abc: |
:arrow_lower_left: |
:arrow_lower_right: |
➡️ :arrow_right: |
⬆️ :arrow_up: |
:arrow_upper_left: |
:arrow_upper_right: |
⏬ :arrow_double_down: |
⏫ :arrow_double_up: |
🔽 :arrow_down_small: |
:arrow_heading_down: |
:arrow_heading_up: |
↩️ :leftwards_arrow_with_hook: |
↪️ :arrow_right_hook: |
:left_right_arrow: |
:arrow_up_down: |
🔼 :arrow_up_small: |
🔃 :arrows_clockwise: |
🔄 :arrows_counterclockwise: |
⏪ :rewind: |
⏩ :fast_forward: |
ℹ️ :information_source: |
🆗 :ok: |
🔀 :twisted_rightwards_arrows: |
🔁 :repeat: |
🔂 :repeat_one: |
🆕 :new: |
🔝 :top: |
🆙 :up: |
🆒 :cool: |
🆓 :free: |
🆖 :ng: |
🎦 :cinema: |
🈁 :koko: |
📶 :signal_strength: |
🈹 :u5272: |
🈴 :u5408: |
🈺 :u55b6: |
🈯 :u6307: |
🈷️ :u6708: |
🈶 :u6709: |
🈵 :u6e80: |
🈚 :u7121: |
🈸 :u7533: |
🈳 :u7a7a: |
🈲 :u7981: |
🈂️ :sa: |
🚻 :restroom: |
🚹 :mens: |
🚺 :womens: |
🚼 :baby_symbol: |
🚭 :no_smoking: |
:parking: |
♿ :wheelchair: |
🚇 :metro: |
🛄 :baggage_claim: |
🉑 :accept: |
🚾 :wc: |
🚰 :potable_water: |
🚮 :put_litter_in_its_place: |
㊙️ :secret: |
㊗️ :congratulations: |
:m: |
🛂 :passport_control: |
🛅 :left_luggage: |
🛃 :customs: |
🉐 :ideograph_advantage: |
🆑 :cl: |
🆘 :sos: |
🆔 :id: |
🚫 :no_entry_sign: |
🔞 :underage: |
📵 :no_mobile_phones: |
🚯 :do_not_litter: |
🚱 :non-potable_water: |
🚳 :no_bicycles: |
🚷 :no_pedestrians: |
🚸 :children_crossing: |
⛔ :no_entry: |
✳️ :eight_spoked_asterisk: |
✴️ :eight_pointed_black_star: |
💟 :heart_decoration: |
🆚 :vs: |
📳 :vibration_mode: |
📴 :mobile_phone_off: |
💹 :chart: |
💱 :currency_exchange: |
♈ :aries: |
♉ :taurus: |
♊ :gemini: |
♋ :cancer: |
♌ :leo: |
♍ :virgo: |
♎ :libra: |
♏ :scorpius: |
♐ :sagittarius: |
♑ :capricorn: |
♒ :aquarius: |
♓ :pisces: |
⛎ :ophiuchus: |
🔯 :six_pointed_star: |
❎ :negative_squared_cross_mark: |
:a: |
:b: |
🆎 :ab: |
:o2: |
💠 :diamond_shape_with_a_dot_inside: |
♻️ :recycle: |
🔚 :end: |
🔛 :on: |
🔜 :soon: |
🕐 :clock1: |
🕜 :clock130: |
🕙 :clock10: |
🕥 :clock1030: |
🕚 :clock11: |
🕦 :clock1130: |
🕛 :clock12: |
🕧 :clock1230: |
🕑 :clock2: |
🕝 :clock230: |
🕒 :clock3: |
🕞 :clock330: |
🕓 :clock4: |
🕟 :clock430: |
🕔 :clock5: |
🕠 :clock530: |
🕕 :clock6: |
🕡 :clock630: |
🕖 :clock7: |
🕢 :clock730: |
🕗 :clock8: |
🕣 :clock830: |
🕘 :clock9: |
🕤 :clock930: |
💲 :heavy_dollar_sign: |
©️ :copyright: |
®️ :registered: |
™️ :tm: |
❌ :x: |
❗ :heavy_exclamation_mark: |
:bangbang: |
:interrobang: |
⭕ :o: |
✖️ :heavy_multiplication_x: |
➕ :heavy_plus_sign: |
➖ :heavy_minus_sign: |
➗ :heavy_division_sign: |
💮 :white_flower: |
💯 :100: |
✔️ :heavy_check_mark: |
☑️ :ballot_box_with_check: |
🔘 :radio_button: |
🔗 :link: |
➰ :curly_loop: |
〰️ :wavy_dash: |
〽️ :part_alternation_mark: |
🔱 :trident: |
:black_square: :black_square: |
:white_square: :white_square: |
✅ :white_check_mark: |
🔲 :black_square_button: |
🔳 :white_square_button: |
⚫ :black_circle: |
⚪ :white_circle: |
🔴 :red_circle: |
🔵 :large_blue_circle: |
🔷 :large_blue_diamond: |
🔶 :large_orange_diamond: |
🔹 :small_blue_diamond: |
🔸 :small_orange_diamond: |
🔺 :small_red_triangle: |
🔻 :small_red_triangle_down: |
 :shipit: |
markdown-snippets/Footer/
[1]: Hello World [2]: Hello Internet
MyWebsite · GitHub @MyGitHub · Other MyProfilename
markdown-snippets/Header/
---
markdown-snippets/License-badges/
markdown-snippets/
Markdown snippets for your documentation files.
1. Go to the snippet that you want to use and click Raw
2. Copy the code Strg+C
3. Paste the code in your markdown file Strg+V
4. Done!
Feel free to add your own templates via pull request 👍
We will take care about the documentation! 🔧
Press the arrows below to expand the preview section
01.01-license-badges/
02.00-footer/
[1]: Hello World [2]: Hello Internet
MyWebsite · GitHub @MyGitHub · Other MyProfilename
03.00-emojis/
:bowtie: |
😄 :smile: |
😆 :laughing: |
|---|---|---|
😊 :blush: |
😃 :smiley: |
:relaxed: |
😏 :smirk: |
😍 :heart_eyes: |
😘 :kissing_heart: |
😚 :kissing_closed_eyes: |
😳 :flushed: |
😌 :relieved: |
😆 :satisfied: |
😁 :grin: |
😉 :wink: |
😜 :stuck_out_tongue_winking_eye: |
😝 :stuck_out_tongue_closed_eyes: |
😀 :grinning: |
😗 :kissing: |
😙 :kissing_smiling_eyes: |
😛 :stuck_out_tongue: |
😴 :sleeping: |
😟 :worried: |
😦 :frowning: |
😧 :anguished: |
😮 :open_mouth: |
😬 :grimacing: |
😕 :confused: |
😯 :hushed: |
😑 :expressionless: |
😒 :unamused: |
😅 :sweat_smile: |
😓 :sweat: |
😥 :disappointed_relieved: |
😩 :weary: |
😔 :pensive: |
😞 :disappointed: |
😖 :confounded: |
😨 :fearful: |
😰 :cold_sweat: |
😣 :persevere: |
😢 :cry: |
😭 :sob: |
😂 :joy: |
😲 :astonished: |
😱 :scream: |
:neckbeard: |
😫 :tired_face: |
😠 :angry: |
😡 :rage: |
😤 :triumph: |
😪 :sleepy: |
😋 :yum: |
😷 :mask: |
😎 :sunglasses: |
😵 :dizzy_face: |
👿 :imp: |
😈 :smiling_imp: |
😐 :neutral_face: |
😶 :no_mouth: |
😇 :innocent: |
👽 :alien: |
💛 :yellow_heart: |
💙 :blue_heart: |
💜 :purple_heart: |
❤️ :heart: |
💚 :green_heart: |
💔 :broken_heart: |
💓 :heartbeat: |
💗 :heartpulse: |
💕 :two_hearts: |
💞 :revolving_hearts: |
💘 :cupid: |
💖 :sparkling_heart: |
✨ :sparkles: |
⭐ :star: |
🌟 :star2: |
💫 :dizzy: |
💥 :boom: |
💥 :collision: |
💢 :anger: |
❗ :exclamation: |
❓ :question: |
❕ :grey_exclamation: |
❔ :grey_question: |
💤 :zzz: |
💨 :dash: |
💦 :sweat_drops: |
🎶 :notes: |
🎵 :musical_note: |
🔥 :fire: |
💩 :hankey: |
💩 :poop: |
💩 :shit: |
👍 :+1: |
👍 :thumbsup: |
👎 :-1: |
👎 :thumbsdown: |
👌 :ok_hand: |
👊 :punch: |
👊 :facepunch: |
✊ :fist: |
✌️ :v: |
👋 :wave: |
✋ :hand: |
✋ :raised_hand: |
👐 :open_hands: |
☝️ :point_up: |
👇 :point_down: |
👈 :point_left: |
👉 :point_right: |
🙌 :raised_hands: |
🙏 :pray: |
👆 :point_up_2: |
👏 :clap: |
💪 :muscle: |
🤘 :metal: |
🖕 :fu: |
🚶 :walking: |
🏃 :runner: |
🏃 :running: |
👫 :couple: |
👪 :family: |
👬 :two_men_holding_hands: |
👭 :two_women_holding_hands: |
💃 :dancer: |
👯 :dancers: |
🙆♀️ :ok_woman: |
🙅 :no_good: |
💁 :information_desk_person: |
🙋 :raising_hand: |
👰♀️ :bride_with_veil: |
:person_with_pouting_face: :person_with_pouting_face: |
:person_frowning: :person_frowning: |
🙇 :bow: |
💏 :couplekiss: |
💑 :couple_with_heart: |
💆 :massage: |
💇 :haircut: |
💅 :nail_care: |
👦 :boy: |
👧 :girl: |
👩 :woman: |
👨 :man: |
👶 :baby: |
👵 :older_woman: |
👴 :older_man: |
:person_with_blond_hair: :person_with_blond_hair: |
👲 :man_with_gua_pi_mao: |
👳♂️ :man_with_turban: |
👷 :construction_worker: |
👮 :cop: |
👼 :angel: |
👸 :princess: |
😺 :smiley_cat: |
😸 :smile_cat: |
😻 :heart_eyes_cat: |
😽 :kissing_cat: |
😼 :smirk_cat: |
🙀 :scream_cat: |
😿 :crying_cat_face: |
😹 :joy_cat: |
😾 :pouting_cat: |
👹 :japanese_ogre: |
👺 :japanese_goblin: |
🙈 :see_no_evil: |
🙉 :hear_no_evil: |
🙊 :speak_no_evil: |
💂♂️ :guardsman: |
💀 :skull: |
🐾 :feet: |
👄 :lips: |
💋 :kiss: |
💧 :droplet: |
👂 :ear: |
👀 :eyes: |
👃 :nose: |
👅 :tongue: |
💌 :love_letter: |
👤 :bust_in_silhouette: |
👥 :busts_in_silhouette: |
💬 :speech_balloon: |
💭 :thought_balloon: |
:feelsgood: |
:finnadie: |
:goberserk: |
:godmode: |
:hurtrealbad: |
:rage1: |
:rage2: |
:rage3: |
:rage4: |
:suspect: |
:trollface: |
☀️ :sunny: |
☔ :umbrella: |
☁️ :cloud: |
|---|---|---|
❄️ :snowflake: |
⛄ :snowman: |
⚡ :zap: |
🌀 :cyclone: |
🌁 :foggy: |
🌊 :ocean: |
🐱 :cat: |
🐶 :dog: |
🐭 :mouse: |
🐹 :hamster: |
🐰 :rabbit: |
🐺 :wolf: |
🐸 :frog: |
🐯 :tiger: |
🐨 :koala: |
🐻 :bear: |
🐷 :pig: |
🐽 :pig_nose: |
🐮 :cow: |
🐗 :boar: |
🐵 :monkey_face: |
🐒 :monkey: |
🐴 :horse: |
🐎 :racehorse: |
🐫 :camel: |
🐑 :sheep: |
🐘 :elephant: |
🐼 :panda_face: |
🐍 :snake: |
🐦 :bird: |
🐤 :baby_chick: |
🐥 :hatched_chick: |
🐣 :hatching_chick: |
🐔 :chicken: |
🐧 :penguin: |
🐢 :turtle: |
🐛 :bug: |
🐝 :honeybee: |
🐜 :ant: |
🪲 :beetle: |
🐌 :snail: |
🐙 :octopus: |
🐠 :tropical_fish: |
🐟 :fish: |
🐳 :whale: |
🐋 :whale2: |
🐬 :dolphin: |
🐄 :cow2: |
🐏 :ram: |
🐀 :rat: |
🐃 :water_buffalo: |
🐅 :tiger2: |
🐇 :rabbit2: |
🐉 :dragon: |
🐐 :goat: |
🐓 :rooster: |
🐕 :dog2: |
🐖 :pig2: |
🐁 :mouse2: |
🐂 :ox: |
🐲 :dragon_face: |
🐡 :blowfish: |
🐊 :crocodile: |
🐪 :dromedary_camel: |
🐆 :leopard: |
🐈 :cat2: |
🐩 :poodle: |
🐾 :paw_prints: |
💐 :bouquet: |
🌸 :cherry_blossom: |
🌷 :tulip: |
🍀 :four_leaf_clover: |
🌹 :rose: |
🌻 :sunflower: |
🌺 :hibiscus: |
🍁 :maple_leaf: |
🍃 :leaves: |
🍂 :fallen_leaf: |
🌿 :herb: |
🍄 :mushroom: |
🌵 :cactus: |
🌴 :palm_tree: |
🌲 :evergreen_tree: |
🌳 :deciduous_tree: |
🌰 :chestnut: |
🌱 :seedling: |
🌼 :blossom: |
🌾 :ear_of_rice: |
🐚 :shell: |
🌐 :globe_with_meridians: |
🌞 :sun_with_face: |
🌝 :full_moon_with_face: |
🌚 :new_moon_with_face: |
🌑 :new_moon: |
🌒 :waxing_crescent_moon: |
🌓 :first_quarter_moon: |
🌔 :waxing_gibbous_moon: |
🌕 :full_moon: |
🌖 :waning_gibbous_moon: |
🌗 :last_quarter_moon: |
🌘 :waning_crescent_moon: |
🌜 :last_quarter_moon_with_face: |
🌛 :first_quarter_moon_with_face: |
🌔 :moon: |
🌍 :earth_africa: |
🌎 :earth_americas: |
🌏 :earth_asia: |
🌋 :volcano: |
🌌 :milky_way: |
⛅ :partly_sunny: |
:octocat: |
:squirrel: :squirrel: |
🎍 :bamboo: |
💝 :gift_heart: |
🎎 :dolls: |
|---|---|---|
🎒 :school_satchel: |
🎓 :mortar_board: |
🎏 :flags: |
🎆 :fireworks: |
🎇 :sparkler: |
🎐 :wind_chime: |
🎑 :rice_scene: |
🎃 :jack_o_lantern: |
👻 :ghost: |
🎅 :santa: |
🎄 :christmas_tree: |
🎁 :gift: |
🔔 :bell: |
🔕 :no_bell: |
🎋 :tanabata_tree: |
🎉 :tada: |
🎊 :confetti_ball: |
🎈 :balloon: |
🔮 :crystal_ball: |
💿 :cd: |
📀 :dvd: |
💾 :floppy_disk: |
📷 :camera: |
📹 :video_camera: |
🎥 :movie_camera: |
💻 :computer: |
📺 :tv: |
📱 :iphone: |
☎️ :phone: |
☎️ :telephone: |
📞 :telephone_receiver: |
📟 :pager: |
📠 :fax: |
💽 :minidisc: |
📼 :vhs: |
🔉 :sound: |
🔈 :speaker: |
🔇 :mute: |
📢 :loudspeaker: |
📣 :mega: |
⌛ :hourglass: |
⏳ :hourglass_flowing_sand: |
⏰ :alarm_clock: |
⌚ :watch: |
📻 :radio: |
📡 :satellite: |
➿ :loop: |
🔍 :mag: |
🔎 :mag_right: |
🔓 :unlock: |
🔒 :lock: |
🔏 :lock_with_ink_pen: |
🔐 :closed_lock_with_key: |
🔑 :key: |
💡 :bulb: |
🔦 :flashlight: |
🔆 :high_brightness: |
🔅 :low_brightness: |
🔌 :electric_plug: |
🔋 :battery: |
📲 :calling: |
📧 :email: |
📫 :mailbox: |
📮 :postbox: |
🛀 :bath: |
🛁 :bathtub: |
🚿 :shower: |
🚽 :toilet: |
🔧 :wrench: |
🔩 :nut_and_bolt: |
🔨 :hammer: |
💺 :seat: |
💰 :moneybag: |
💴 :yen: |
💵 :dollar: |
💷 :pound: |
💶 :euro: |
💳 :credit_card: |
💸 :money_with_wings: |
📧 :e-mail: |
📥 :inbox_tray: |
📤 :outbox_tray: |
✉️ :envelope: |
📨 :incoming_envelope: |
📯 :postal_horn: |
📪 :mailbox_closed: |
📬 :mailbox_with_mail: |
📭 :mailbox_with_no_mail: |
🚪 :door: |
🚬 :smoking: |
💣 :bomb: |
🔫 :gun: |
🔪 :hocho: |
💊 :pill: |
💉 :syringe: |
📄 :page_facing_up: |
📃 :page_with_curl: |
📑 :bookmark_tabs: |
📊 :bar_chart: |
📈 :chart_with_upwards_trend: |
📉 :chart_with_downwards_trend: |
📜 :scroll: |
📋 :clipboard: |
📆 :calendar: |
📅 :date: |
📇 :card_index: |
📁 :file_folder: |
📂 :open_file_folder: |
✂️ :scissors: |
📌 :pushpin: |
📎 :paperclip: |
✒️ :black_nib: |
✏️ :pencil2: |
📏 :straight_ruler: |
📐 :triangular_ruler: |
📕 :closed_book: |
📗 :green_book: |
📘 :blue_book: |
📙 :orange_book: |
📓 :notebook: |
📔 :notebook_with_decorative_cover: |
📒 :ledger: |
📚 :books: |
🔖 :bookmark: |
📛 :name_badge: |
🔬 :microscope: |
🔭 :telescope: |
📰 :newspaper: |
🏈 :football: |
🏀 :basketball: |
⚽ :soccer: |
⚾ :baseball: |
🎾 :tennis: |
🎱 :8ball: |
🏉 :rugby_football: |
🎳 :bowling: |
⛳ :golf: |
🚵 :mountain_bicyclist: |
🚴 :bicyclist: |
🏇 :horse_racing: |
🏂 :snowboarder: |
🏊 :swimmer: |
🏄 :surfer: |
🎿 :ski: |
:spades: |
:hearts: |
:clubs: |
:diamonds: |
💎 :gem: |
💍 :ring: |
🏆 :trophy: |
🎼 :musical_score: |
🎹 :musical_keyboard: |
🎻 :violin: |
👾 :space_invader: |
🎮 :video_game: |
🃏 :black_joker: |
🎴 :flower_playing_cards: |
🎲 :game_die: |
🎯 :dart: |
🀄 :mahjong: |
🎬 :clapper: |
📝 :memo: |
📝 :pencil: |
📖 :book: |
🎨 :art: |
🎤 :microphone: |
🎧 :headphones: |
🎺 :trumpet: |
🎷 :saxophone: |
🎸 :guitar: |
👞 :shoe: |
👡 :sandal: |
👠 :high_heel: |
💄 :lipstick: |
👢 :boot: |
👕 :shirt: |
👕 :tshirt: |
👔 :necktie: |
👚 :womans_clothes: |
👗 :dress: |
🎽 :running_shirt_with_sash: |
👖 :jeans: |
👘 :kimono: |
👙 :bikini: |
🎀 :ribbon: |
🎩 :tophat: |
👑 :crown: |
👒 :womans_hat: |
👞 :mans_shoe: |
🌂 :closed_umbrella: |
💼 :briefcase: |
👜 :handbag: |
👝 :pouch: |
👛 :purse: |
👓 :eyeglasses: |
🎣 :fishing_pole_and_fish: |
☕ :coffee: |
🍵 :tea: |
🍶 :sake: |
🍼 :baby_bottle: |
🍺 :beer: |
🍻 :beers: |
🍸 :cocktail: |
🍹 :tropical_drink: |
🍷 :wine_glass: |
🍴 :fork_and_knife: |
🍕 :pizza: |
🍔 :hamburger: |
🍟 :fries: |
🍗 :poultry_leg: |
🍖 :meat_on_bone: |
🍝 :spaghetti: |
🍛 :curry: |
🍤 :fried_shrimp: |
🍱 :bento: |
🍣 :sushi: |
🍥 :fish_cake: |
🍙 :rice_ball: |
🍘 :rice_cracker: |
🍚 :rice: |
🍜 :ramen: |
🍲 :stew: |
🍢 :oden: |
🍡 :dango: |
🥚 :egg: |
🍞 :bread: |
🍩 :doughnut: |
🍮 :custard: |
🍦 :icecream: |
🍨 :ice_cream: |
🍧 :shaved_ice: |
🎂 :birthday: |
🍰 :cake: |
🍪 :cookie: |
🍫 :chocolate_bar: |
🍬 :candy: |
🍭 :lollipop: |
🍯 :honey_pot: |
🍎 :apple: |
🍏 :green_apple: |
🍊 :tangerine: |
🍋 :lemon: |
🍒 :cherries: |
🍇 :grapes: |
🍉 :watermelon: |
🍓 :strawberry: |
🍑 :peach: |
🍈 :melon: |
🍌 :banana: |
🍐 :pear: |
🍍 :pineapple: |
🍠 :sweet_potato: |
🍆 :eggplant: |
🍅 :tomato: |
🌽 :corn: |
🏠 :house: |
🏡 :house_with_garden: |
🏫 :school: |
|---|---|---|
🏢 :office: |
🏣 :post_office: |
🏥 :hospital: |
🏦 :bank: |
🏪 :convenience_store: |
🏩 :love_hotel: |
🏨 :hotel: |
💒 :wedding: |
⛪ :church: |
🏬 :department_store: |
🏤 :european_post_office: |
🌇 :city_sunrise: |
🌆 :city_sunset: |
🏯 :japanese_castle: |
🏰 :european_castle: |
⛺ :tent: |
🏭 :factory: |
🗼 :tokyo_tower: |
🗾 :japan: |
🗻 :mount_fuji: |
🌄 :sunrise_over_mountains: |
🌅 :sunrise: |
🌠 :stars: |
🗽 :statue_of_liberty: |
🌉 :bridge_at_night: |
🎠 :carousel_horse: |
🌈 :rainbow: |
🎡 :ferris_wheel: |
⛲ :fountain: |
🎢 :roller_coaster: |
🚢 :ship: |
🚤 :speedboat: |
⛵ :boat: |
⛵ :sailboat: |
🚣 :rowboat: |
⚓ :anchor: |
🚀 :rocket: |
:airplane: |
🚁 :helicopter: |
🚂 :steam_locomotive: |
🚊 :tram: |
🚞 :mountain_railway: |
🚲 :bike: |
🚡 :aerial_tramway: |
🚟 :suspension_railway: |
🚠 :mountain_cableway: |
🚜 :tractor: |
🚙 :blue_car: |
🚘 :oncoming_automobile: |
🚗 :car: |
🚗 :red_car: |
🚕 :taxi: |
🚖 :oncoming_taxi: |
🚛 :articulated_lorry: |
🚌 :bus: |
🚍 :oncoming_bus: |
🚨 :rotating_light: |
🚓 :police_car: |
🚔 :oncoming_police_car: |
🚒 :fire_engine: |
🚑 :ambulance: |
🚐 :minibus: |
🚚 :truck: |
🚋 :train: |
🚉 :station: |
🚆 :train2: |
🚅 :bullettrain_front: |
🚄 :bullettrain_side: |
🚈 :light_rail: |
🚝 :monorail: |
🚃 :railway_car: |
🚎 :trolleybus: |
🎫 :ticket: |
⛽ :fuelpump: |
🚦 :vertical_traffic_light: |
🚥 :traffic_light: |
:warning: |
🚧 :construction: |
🔰 :beginner: |
🏧 :atm: |
🎰 :slot_machine: |
🚏 :busstop: |
💈 :barber: |
♨️ :hotsprings: |
🏁 :checkered_flag: |
🎌 :crossed_flags: |
🏮 :izakaya_lantern: |
🗿 :moyai: |
🎪 :circus_tent: |
🎭 :performing_arts: |
📍 :round_pushpin: |
🚩 :triangular_flag_on_post: |
🇯🇵 :jp: |
🇰🇷 :kr: |
🇨🇳 :cn: |
🇺🇸 :us: |
🇫🇷 :fr: |
🇪🇸 :es: |
🇮🇹 :it: |
🇷🇺 :ru: |
🇬🇧 :gb: |
🇬🇧 :uk: |
🇩🇪 :de: |
1️⃣ :one: |
2️⃣ :two: |
3️⃣ :three: |
|---|---|---|
4️⃣ :four: |
5️⃣ :five: |
6️⃣ :six: |
7️⃣ :seven: |
8️⃣ :eight: |
9️⃣ :nine: |
🔟 :keycap_ten: |
🔢 :1234: |
0️⃣ :zero: |
#️⃣ :hash: |
🔣 :symbols: |
:arrow_backward: |
⬇️ :arrow_down: |
:arrow_forward: |
⬅️ :arrow_left: |
🔠 :capital_abcd: |
🔡 :abcd: |
🔤 :abc: |
:arrow_lower_left: |
:arrow_lower_right: |
➡️ :arrow_right: |
⬆️ :arrow_up: |
:arrow_upper_left: |
:arrow_upper_right: |
⏬ :arrow_double_down: |
⏫ :arrow_double_up: |
🔽 :arrow_down_small: |
:arrow_heading_down: |
:arrow_heading_up: |
↩️ :leftwards_arrow_with_hook: |
↪️ :arrow_right_hook: |
:left_right_arrow: |
:arrow_up_down: |
🔼 :arrow_up_small: |
🔃 :arrows_clockwise: |
🔄 :arrows_counterclockwise: |
⏪ :rewind: |
⏩ :fast_forward: |
ℹ️ :information_source: |
🆗 :ok: |
🔀 :twisted_rightwards_arrows: |
🔁 :repeat: |
🔂 :repeat_one: |
🆕 :new: |
🔝 :top: |
🆙 :up: |
🆒 :cool: |
🆓 :free: |
🆖 :ng: |
🎦 :cinema: |
🈁 :koko: |
📶 :signal_strength: |
🈹 :u5272: |
🈴 :u5408: |
🈺 :u55b6: |
🈯 :u6307: |
🈷️ :u6708: |
🈶 :u6709: |
🈵 :u6e80: |
🈚 :u7121: |
🈸 :u7533: |
🈳 :u7a7a: |
🈲 :u7981: |
🈂️ :sa: |
🚻 :restroom: |
🚹 :mens: |
🚺 :womens: |
🚼 :baby_symbol: |
🚭 :no_smoking: |
:parking: |
♿ :wheelchair: |
🚇 :metro: |
🛄 :baggage_claim: |
🉑 :accept: |
🚾 :wc: |
🚰 :potable_water: |
🚮 :put_litter_in_its_place: |
㊙️ :secret: |
㊗️ :congratulations: |
:m: |
🛂 :passport_control: |
🛅 :left_luggage: |
🛃 :customs: |
🉐 :ideograph_advantage: |
🆑 :cl: |
🆘 :sos: |
🆔 :id: |
🚫 :no_entry_sign: |
🔞 :underage: |
📵 :no_mobile_phones: |
🚯 :do_not_litter: |
🚱 :non-potable_water: |
🚳 :no_bicycles: |
🚷 :no_pedestrians: |
🚸 :children_crossing: |
⛔ :no_entry: |
✳️ :eight_spoked_asterisk: |
✴️ :eight_pointed_black_star: |
💟 :heart_decoration: |
🆚 :vs: |
📳 :vibration_mode: |
📴 :mobile_phone_off: |
💹 :chart: |
💱 :currency_exchange: |
♈ :aries: |
♉ :taurus: |
♊ :gemini: |
♋ :cancer: |
♌ :leo: |
♍ :virgo: |
♎ :libra: |
♏ :scorpius: |
♐ :sagittarius: |
♑ :capricorn: |
♒ :aquarius: |
♓ :pisces: |
⛎ :ophiuchus: |
🔯 :six_pointed_star: |
❎ :negative_squared_cross_mark: |
:a: |
:b: |
🆎 :ab: |
:o2: |
💠 :diamond_shape_with_a_dot_inside: |
♻️ :recycle: |
🔚 :end: |
🔛 :on: |
🔜 :soon: |
🕐 :clock1: |
🕜 :clock130: |
🕙 :clock10: |
🕥 :clock1030: |
🕚 :clock11: |
🕦 :clock1130: |
🕛 :clock12: |
🕧 :clock1230: |
🕑 :clock2: |
🕝 :clock230: |
🕒 :clock3: |
🕞 :clock330: |
🕓 :clock4: |
🕟 :clock430: |
🕔 :clock5: |
🕠 :clock530: |
🕕 :clock6: |
🕡 :clock630: |
🕖 :clock7: |
🕢 :clock730: |
🕗 :clock8: |
🕣 :clock830: |
🕘 :clock9: |
🕤 :clock930: |
💲 :heavy_dollar_sign: |
©️ :copyright: |
®️ :registered: |
™️ :tm: |
❌ :x: |
❗ :heavy_exclamation_mark: |
:bangbang: |
:interrobang: |
⭕ :o: |
✖️ :heavy_multiplication_x: |
➕ :heavy_plus_sign: |
➖ :heavy_minus_sign: |
➗ :heavy_division_sign: |
💮 :white_flower: |
💯 :100: |
✔️ :heavy_check_mark: |
☑️ :ballot_box_with_check: |
🔘 :radio_button: |
🔗 :link: |
➰ :curly_loop: |
〰️ :wavy_dash: |
〽️ :part_alternation_mark: |
🔱 :trident: |
:black_square: :black_square: |
:white_square: :white_square: |
✅ :white_check_mark: |
🔲 :black_square_button: |
🔳 :white_square_button: |
⚫ :black_circle: |
⚪ :white_circle: |
🔴 :red_circle: |
🔵 :large_blue_circle: |
🔷 :large_blue_diamond: |
🔶 :large_orange_diamond: |
🔹 :small_blue_diamond: |
🔸 :small_orange_diamond: |
🔺 :small_red_triangle: |
🔻 :small_red_triangle_down: |
:shipit: |
xtras-01-inline-html/
Strg+X Strg + X Or any other text
This is a text with SuperScript You can use it for footnotes1
[1]: See footnotes
01/01/2000
Text on the top right cornermarkdown-snippets/xtrasInline-html/
Strg+X Strg + X Or any other text
This is a text with SuperScript You can use it for footnotes1
[1]: See footnotes
01/01/2000
Text on the top right cornerofficial/
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
Here we write upgrading notes for brands. It's a team effort to make them as straightforward as possible.
- PROJECTNAME-XXXX MINOR Ticket title goes here.
- PROJECTNAME-YYYY PATCH Ticket title goes here.
Here we would have the update steps for 1.2.4 for people to follow.
- PROJECTNAME-ZZZZ PATCH Drupal.org is now used for composer.
- PROJECTNAME-TTTT PATCH Add logic to runsheet teaser delete to delete corresponding schedule cards.
- PROJECTNAME-UUUU MINOR Fix module foo tests
- PROJECTNAME-RRRR MAJOR Module foo's timeline uses the browser timezone for date resolution
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at kylelobo20@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq
These are the directories that we are actively using in the development:
- frontend/server/controllers: The controllers do the business logic and expose the server API.
- frontend/server/libs: Libraries and utilities.
- frontend/server/libs/dao: Data Access Objects [DAO] and Value Objects [VO]. Classes used to represent database schemes and facilitate their use by the controllers.
- frontend/templates: Smarty templates used to generate the HTML that is displayed to users.
- frontend/www: The complete contents of the Internet page.
Content:
- js /
- css /
As the name implies, here is where all the javascript fonts and javascript frameworks reside. When you want to make changes, please minify the javascript and then upload.
Similar to js, here are the minified css files.
Content:
- dao /
- controllers /
None of these modules should be accessible to the outside world. The only one that can call them is the user interface. That's why they're under the www folder.
The dao folder contains the classes for the data access layer. It has 2 things to know: data access objects and value objects. The value objects (VO) are nothing much but classes that are mapped directly to each of the tables in the database. Therefore, there is a class in there called Users, since there is a table with the same name. This class has its setters and getters for each of the fields in the database. The data access objects (dao) are static classes for each of the tables, and they serve to obtain and make the objects persistent vo.
Here is more info about this model
The controllers are where the decisions are made. The controller uses the dao's and vo's to make decisions, and never call the database directly. This way, we avoid having separate controllers for each module of the project.
- You can validate that your code complies with these guidelines by running
stuff/php-format.py validate - Tabs, no spaces
- End of line should should be Unix style (
\n), not Windows style (\r\n) - Opening brackets goes in the same line as the last statement
if (condition) {
stuff;
}
- A space between keywords and parenthesis for:
if,else,while,switch,catch,function - Function calls have no space before the parentheses
- No spaces are left inside the parentheses
- A space after each comma, but without space before
- All binary operators must have one space before and one after
- There should not be more than one contiguous blank line
- There should be no empty comments
- You should not use block comments
/ * ... * /, only line// ... - Changes in functionality must be accompanied by their respective new / modified tests
- Exceptions must be used to report erroneous states. The use of functions that return true / false is allowed when they are expected values
- Use [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization) when appropriate, mainly in the administration of resources (files, etc ...)
- Contributing to The Documentation Compendium is fairly easy. This document shows you how to get started
- The Codebase Structure has detailed information about how the various files in this project are structured
- Please ensure that any changes you make are in accordance with the Coding Guidelines of this repo
- Fork the repo
- Check out a new branch based and name it to what you intend to do:
- Example:
If you get an error, you may need to fetch fooBar first by using
$ git checkout -b BRANCH_NAME$ git remote update && git fetch - Use one branch per fix / feature
- Example:
- Commit your changes
- Please provide a git message that explains what you've done
- Please make sure your commits follow the conventions
- Commit to the forked repository
- Example:
$ git commit -am 'Add some fooBar'
- Push to the branch
- Example:
$ git push origin BRANCH_NAME
- Example:
- Make a pull request
- Make sure you send the PR to the
fooBarbranch - Travis CI is watching you!
- Make sure you send the PR to the
If you follow these instructions, your PR will land pretty safely in the main repo!
official/ISSUE_TEMPLATES/
name: Bug report about: Create a report to help us improve title: "" labels: "" assignees: ""
Describe the bug A clear and concise description of what the bug is.
To Reproduce Steps to reproduce the behavior:
- Go to '...'
- Click on '....'
- Scroll down to '....'
- See error
Expected behavior A clear and concise description of what you expected to happen.
Screenshots If applicable, add screenshots to help explain your problem.
Desktop (please complete the following information):
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
Smartphone (please complete the following information):
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
Additional context Add any other context about the problem here.
name: Custom issue template about: Describe this issue template's purpose here. title: "" labels: "" assignees: ""
name: Feature request about: Suggest an idea for this project title: "" labels: "" assignees: ""
Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Describe the solution you'd like A clear and concise description of what you want to happen.
Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.
Additional context Add any other context or screenshots about the feature request here.
official/
🚨 Please review the guidelines for contributing to this repository.
- Make sure you are requesting to pull a topic/feature/bugfix branch (right side). Don't request your master!
- Make sure you are making a pull request against the fooBar branch (left side).
- Check the commit's or even all commits' message styles matches our requested structure.
- Check your code additions will fail neither code linting checks nor unit test.
Please describe your pull request.
❤️ Thank you!
official/README_TEMPLATES/
🤖 Few lines describing what your bot does.
- About
- Demo / Working
- How it works
- Usage
- Getting Started
- Deploying your own bot
- Built Using
- TODO
- Contributing
- Authors
- Acknowledgments
Write about 1-2 paragraphs describing the purpose of your bot.
The bot first extracts the word from the comment and then fetches word definitions, part of speech, example and source from the Oxford Dictionary API.
If the word does not exist in the Oxford Dictionary, the Oxford API then returns a 404 response upon which the bot then tries to fetch results form the Urban Dictionary API.
The bot uses the Pushshift API to fetch comments, PRAW module to reply to comments and Heroku as a server.
The entire bot is written in Python 3.6
To use the bot, type:
!dict word
The first part, i.e. "!dict" is not case sensitive.
The bot will then give you the Oxford Dictionary (or Urban Dictionary; if the word does not exist in the Oxford Dictionary) definition of the word as a comment reply.
!dict what is love
Definition:
Baby, dont hurt me~ Dont hurt me~ no more.
Example:
Dude1: Bruh, what is love? Dude2: Baby, dont hurt me, dont hurt me- no more! Dude1: dafuq?
Source: https://www.urbandictionary.com/define.php?term=what%20is%20love
Beep boop. I am a bot. If there are any issues, contact my Master
Want to make a similar reddit bot? Check out: GitHub
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them.
Give examples
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo.
To see an example project on how to deploy your bot, please see my own configuration:
- @kylelobo - Idea & Initial work
See also the list of contributors who participated in this project.
- Hat tip to anyone whose code was used
- Inspiration
- References
Few lines describing your project.
- Problem Statement
- Idea / Solution
- Dependencies / Limitations
- Future Scope
- Setting up a local environment
- Usage
- Technology Stack
- Contributing
- Authors
- Acknowledgments
It is useful to design and follow a specific format when writing a problem statement. While there are several options for doing this, the following is a simple and straightforward template often used in Business Analysis to maintain focus on defining the problem.
- IDEAL: This section is used to describe the desired or “to be” state of the process or product. At large, this section should illustrate what the expected environment would look like once the solution is implemented.
- REALITY: This section is used to describe the current or “as is” state of the process or product.
- CONSEQUENCES: This section is used to describe the impacts on the business if the problem is not fixed or improved upon. This includes costs associated with loss of money, time, productivity, competitive advantage, and so forth.
Following this format will result in a workable document that can be used to understand the problem and elicit requirements that will lead to a winning solution.
This section is used to describe potential solutions.
Once the ideal, reality, and consequences sections have been completed, and understood, it becomes easier to provide a solution for solving the problem.
- What are the dependencies of your project?
- Describe each limitation in detailed but concise terms
- Explain why each limitation exists
- Provide the reasons why each limitation could not be overcome using the method(s) chosen to acquire.
- Assess the impact of each limitation in relation to the overall findings and conclusions of your project, and if appropriate, describe how these limitations could point to the need for further research.
Write about what you could not develop during the course of the Hackathon; and about what your project can achieve in the future.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them.
Give examples
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
Give the example
And repeat
until finished
Add notes about how to use the system.
- @kylelobo - Idea & Initial work
See also the list of contributors who participated in this project.
- Hat tip to anyone whose code was used
- Inspiration
- References
TODO
Write about 1-2 paragraphs describing the purpose of your project.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them.
Give examples
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo.
Add notes about how to use the system.
- Minimal.md - Quickly set up a very basic, minimal README for your project.
- Standard.md - A detailed, comprehensive template that covers all the major aspects of a README.
- Hackathon.md - At a Hackathon and quickly need to set up a beautiful, thorough README that leaves a lasting impression on the judges? This is the template for you!
- Bot.md - If you have an awesome Bot that you want to share with others.
- IoT.md - This repo nails down the nitty-gritties that go into documenting an IoT project.
Few lines describing your project.
Write about 1-2 paragraphs describing the purpose of your project.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them.
Give examples
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo.
Explain how to run the automated tests for this system.
Explain what these tests test and why
Give an example
Explain what these tests test and why
Give an example
Add notes about how to use the system.
Add additional notes about how to deploy this on a live system.
- @kylelobo - Idea & Initial work
See also the list of contributors who participated in this project.
- Hat tip to anyone whose code was used
- Inspiration
- References
official/
- Document the README.md file in the README_TEMPLATES folder.
- Make an IoT template (Refer to the various Arduino project documentations for assistance). This template must be detailed and should go in-depth into the various hardware terminologies.
- Make a minimal IoT template.
- Add a COMMIT_MESSAGE_GUIDELINES.md file.
- Translate the templates into different languages - Chinese, French, German, Hindi, Italian, Japanese, Korean, Portuguese, Russian, Spanish, etc.
open-source-templates/
Resources for generating a changelog:
skywinder/Github-Changelog-Generator - generates a full changelog that overwrites the existing CHANGELOG.md.
hzalaz/wt-oss-milestone-changelog - generates a snippet of Markdown that can be added to a CHANGELOG.md.
conventional-changelog/conventional-changelog - generates a full changelog based on commit history with the option to append to an existing changelog.
Our company values guide us in our day-to-day interactions and decision-making. Our open source projects are no exception. Trust, respect, collaboration and transparency are core values we believe should live and breathe within our projects. Our community welcomes participants from around the world with different experiences, unique perspectives, and great ideas to share.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Attempting collaboration before conflict
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- Violence, threats of violence, or inciting others to commit self-harm
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, intentionally spreading misinformation, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Abuse of the reporting process to intentionally harass or exclude others
- Advocating for, or encouraging, any of the above behavior
- Other conduct which could reasonably be considered inappropriate in a professional setting
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting us anonymously through this form. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
If you are unsure whether an incident is a violation, or whether the space where the incident took place is covered by our Code of Conduct, we encourage you to still report it. We would prefer to have a few extra reports where we decide to take no action, than to leave an incident go unnoticed and unresolved that may result in an individual or group to feel like they can no longer participate in the community. Reports deemed as not a violation will also allow us to improve our Code of Conduct and processes surrounding it. If you witness a dangerous situation or someone in distress, we encourage you to report even if you are only an observer.
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
Please read Auth0's contribution guidelines.
- PR for docs site update, if needed
- Code-level documentation expectations
- 100% documentation coverage for PRs
- Include links to relevant Auth0 doc pages
Information about compiling CSS, JS, SVG, etc.
Link to README installation steps and include anything additional needed to contribute to the project.
General information about the test suite and how to format and structure tests.
Any additional information needed to run the test suite. Include bash-formatted commands like:
composer test
bundle exec rake testAlso include any information about essential manual tests.
Information about scripts to run before committing.
What CI checks for and how to pass.
Anything not covered in the general guidelines linked above.
A big welcome and thank you for considering contributing to Auth0 open source projects! It’s people like you that make it a reality for users in our community.
Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests.
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.
Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both:
- To report security vulnerabilities, please use our Responsible Disclosure Program which is monitored by our security team.
- Search for existing Issues and PRs before creating your own.
- We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking.
- If you've never contributed before, see the first timer's guide on our blog for resources and tips on how to get started.
Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate.
If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a reaction can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter.
PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should:
- Only fix/add the functionality in question OR address wide-spread whitespace/style issues, not both.
- Add unit or integration tests for fixed or changed functionality (if a test suite already exists).
- Address a single concern in the least number of changed lines as possible.
- Include documentation in the repo or on our docs site.
- Be accompanied by a complete Pull Request template (loaded automatically when a PR is created).
For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes.
In general, we follow the "fork-and-pull" Git workflow
- Fork the repository to your own Github account
- Clone the project to your machine
- Create a branch locally with a succinct but descriptive name
- Commit changes to the branch
- Following any formatting and testing guidelines specific to this repo
- Push changes to your fork
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.
Join us in the Auth0 Community and post your question there in the correct category with a descriptive tag.
open-source-templates/
The section after the title is where we say what this library, sample, or SDK does in a few sentences. Consider adding:
- Short description of use case + problem(s) solved. Consider the following (from here): - Have you described what it is and what the benefits are in a way a non-developer can understand? - If someone Googles to try to learn more about it, is this description easy to find? - Is this description easily skimmable? If someone looks at it for 6 seconds can they be convinced? - Do you compare your tool to other similar tools so people feel educated about pros/cons of yours? - If performance matters, do you have easy-to-skim benchmarks that include comparing it to other tools? - Do you have a demo? If it’s open source, are there well documented and easy to build samples/demos? Have you talked with developers who may be interested to learn about why they haven’t tried it or don’t use it?
- Platform/language version supported
- Links to the project in other repos (npm, packagist, etc)
- Information about maintained and deprecated branches
- Repo status - maintained, deprecated, etc.
- Other resources:
Search-replace the org/repo in the badge images and links below.
Note: See individual language directories in this repo for technology-specific badges.
Make sure this is updated based on the sections included:
- Documentation
- Installation
- Getting Started
- Contributing
- Support + Feedback
- Vulnerability Reporting
- Thank You
- What is Auth0
- License
This section should describe the documentation contained within this repo as well as links to other helpful pages. Full documentation for the library should not, ideally, be located in the repo README and must not be duplicated from somewhere else. If the README is being updated to adhere to these guidelines and the documentation only exists in the readme, consider moving it to a docs page or a Quickstart.
Consider adding:
- How to generate documentation in the project (if applicable)
- Links to Quickstarts and sample projects
- Links to any specific
.mdfiles in the repo - Links to auth0/docs
- Links to Auth0 blog posts
- Links to any helpful supporting information about the project
- Links to relevant Community posts (consider parsing and adding somewhere more easily accessible)
This section should outline what is required to install and configure this project. Consider adding:
- Prerequisites for use
- Command line instructions using
bashsyntax:
npm install
composer install- Links to information about package manager used
- Information about
.envvalues needed (include anexample.envfile) - Include different ways to install, indicate preferred method
- Include instructions on how to install older versions
This section should include basic usage instructions that can be successfully completed after Installation above. This section should be a short introduction to how this library can be used, not a duplication of existing Quickstarts.
Consider adding:
- Working with the Authentication API
- Basic login
- Basic code exchange
- Authorize redirect
- Logout
- Working with the Management API
- Perform a Client Credentials grant
- Get Users by page
- Get Clients by page
- Get Connections by page
- Other common tasks
- Security recommendations
- State validation
- ID token verification
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
- Auth0's general contribution guidelines
- Auth0's code of conduct guidelines
- This repo's contribution guide
Include information on how to get support. Consider adding:
- Use Issues for code-level support
- Use Community for usage, questions, specific cases
- Link to other support forums and FAQs
Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.
Auth0 helps you to easily:
- implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.)
- log in users with username/password databases, passwordless, or multi-factor authentication
- link multiple user accounts together
- generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely
- access demographics and analytics detailing how, when, and where users are logging in
- enrich user profiles from other data sources using customizable JavaScript rules
Information on the dependencies used, if desired.
Link to LICENSE doc. Typically MIT but can be different for a specific platform.
This repo contains sample files to be used in Auth0 open source software repositories. These files are guidelines that can be used in an Auth0 or any open source project to ensure that the project is described properly, the contribution process is clear, and additional tools like CI, coverage monitors, and quality checkers are configured properly.
This repo can be cloned, modified, then re-purposed for new open source projects. It can also be used piecemeal to improve existing repos.
The core of open source repo quality is the README.md file that's displayed on the repo's homepage in Github. The README-sample.md included here was collaboratively created by Auth0's SDK engineering team and community engineering team based on samples of high-quality README files around the web.
Most sections within this file should be considered required, even if that section contains a link to a more relevant page. Certain sections will contain repo-specific information and should be modified as needed:
- Description (below the title)
- Badges
- Documentation
- Installation
- Getting Started
- Thank you
- License
Other sections should be used as-is with minimal changes:
- Table of Contents
- Contribution
- Support + Feedback
- Vulnerability Reporting
- What is Auth0?
The issue and PR templates contained in this repo are general guidelines for what to include. What is being asked for is entirely up to the repo maintainer but a template of some kind should be included.
See README-sample.md for guidelines.
This file contains files that will be excluded from git. Modify as needed based on the technology being used.
Additional template files have been included here for the specific technology that we work with. These should be considered as guidelines and not enforced in any way.
We appreciate feedback and contribution to this template! Before you get started, please see the following:
A big thank you to all of our sources of inspiration!
- First Contributions by @Roshanjossey
- First Timers Only
- Sane Github Labels
- Awesome README by @matiassingers
... and many more!
This repo is covered under The MIT License.
