Skip to content

xiGUAwanOU/tech-note

Repository files navigation

Tech Note

The conten in this tech note is:

  1. either cheatsheet-like, which will be referenced later;
  2. interesting understandings, which are worth to be read again later.

For a source code highlighting language list, see linguist project.

Subfolders

There are only two first-level sub-directories:

  1. cheatsheets
  2. notes

Within the two first-level sub-directories, the articles are seperated by its applied domain:

  1. general
  2. frontend
  3. backend
  4. devops
  5. game
  6. compiler
  7. embedded
  8. art
  9. ...

Filename

Filename must be kebab-cased. The first word in the filename is the main technology that the tech note is talking about.

Keywords

Keywords are one of the searching criteria. They should be specified like:

keywords responsive, head, viewport, meta, media, query, breakpoint, html, css

Labels

Label can be added according to the:

  1. programming language
  2. framework/library
  3. technology

Tech notes are categorized by their labels. They should be specified like:

labels web, html, css, responsive

The first label must match the first word in the filename.

Title

Title is a summary of the content of the tech note, and also one of the searching criteria. Just use markdown first-level title:

# Web: Responsive Design Basics

The first part of the title must match the first word in the filename.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published