登录
当前位置： 首页 > 软件库 > 程序开发 > Emoji 表情相关 >

format-README

Формат файла README
授权协议 Readme
开发语言 JavaScript
所属分类 程序开发、 Emoji 表情相关
软件类型 开源软件
地区 不详
投 递 者 杜经艺
操作系统 跨平台
开源组织 无
适用人群 未知
软件官网
软件文档
官方下载
安全指数
 软件概览

Описание разметки файла README.md

Для описания проектов на GitHub используется README.md, который пишется на языке разметки markdown. Что и как поддерживается расписано ниже. Также существует еще один формат - reStructuredText, описание которого вынесено в отдельный файл README.rst.

Оглавление

  1. Разделительная черта
  2. Заголовки
  3. Работа с выделением текста
  4. Использование эмодзи (emoji)
  5. Использование цитирования в тексте
  6. Подсветка кода
  7. Списки
    1. Маркированный
    2. Нумерованный
    3. Смешанные списки
    4. Список задач
  8. Ссылки
  9. Вставка изображения
  10. Вставка таблиц
  11. Дополнения

Разделительная черта

При использовании

____

получается разделительная черта

⬆️ Оглавление

Заголовки

Всего существует шесть уровней заголовков. Для того, чтобы создать заголовок, необходимо в начале строки добавить символы #, в количестве равном его уровню.

Заголовок первого уровня

# Заголовок 1

Заголовок первого уровня также можно создать:

Заголовок 1
===========

Заголовок второго уровня

## Заголовок 2

Заголовок второго уровня также можно создать:

Заголовок 2
-----------

Заголовок третьего уровня

### Заголовок 3

Заголовок четвертого уровня

#### Заголовок 4
Заголовок пятого уровня
##### Заголовок 5
Заголовок шестого уровня
###### Заголовок 6

⬆️ Оглавление

Работа с выделением текста

~~Зачеркнутый текст~~

Зачеркнутый текст (Strikethrough)

Для выделения текста жирным или наклонным и их сочетания можно использовать комбинации * или _

**Жирный текст (bold)**

Жирный текст (bold)

*Наклонный текст (italic)*

Наклонный текст (italic)

***Жирный наклонный текст (bold italic)***

Жирный наклонный текст (bold italic)

__Жирный текст (bold)__

Жирный текст (bold)

_Наклонный текст (italic)_

Наклонный текст (italic)

___Жирный наклонный текст (bold italic)___

Жирный наклонный текст (bold italic)

~~*__Тут странный текст__*~~

Тут странный текст

⬆️ Оглавление

Использование эмодзи (emoji)

В самом тексте можно использовать эмодзи, например написать вот так:
✅ Это уже сделано
❎ Я не буду это делать
�� делать или не делать, вот в чем вопрос?
В оригинале это выглядит так (в конце строки четыре (4) пробела для того, что бы был переход на новую строку):

✅ Это уже сделано    
❎ Я не буду это делать    
�� делать или не делать, вот в чем вопрос?

Список работающих Эмодзи находится тут -> emoji.md

⬆️ Оглавление

Использование цитирования в тексте

> Цитата (уровень 1)    
> > Вложенная цитата (уровень 2)    
> > > Вложенная цитата (уровень 3)    

> > Продолжение цитаты (уровень 2)    

> Продолжение цитаты (уровень 1)

Цитата (уровень 1)

Вложенная цитата (уровень 2)

Вложенная цитата (уровень 3)

Продолжение цитаты (уровень 2)

Продолжение цитаты (уровень 1)

Внешний вид, конечно, не очень, но может и пригодиться.

⬆️ Оглавление

Подсветка кода

Если нужно выделить слово или фразу внутри строки, то используются одинарные обратные кавычки (`):

Это `слово` будет выделено

Для выделения в блоки - тройные:

```
    Здесь может быть
    Ваша реклама
```

Дополнительно можно задавать язык кода внутри блока, указав его после первых трех кавычек:

```html
    <input type="text">
```

```css
    body {
        margin: 0;
        padding: 0;
    }
```

```php
    <?php phpinfo();?>
```

Пример блока для C#:

using MarkdownSharp;
using MarkdownSharp.Extensions.Mal;

Markdown mark = new Markdown();

// Short link for MAL - 
// http://myanimelist.net/people/413/Kitamura_Eri => mal://Kitamura_Eri
mark.AddExtension(new Articles()); 
mark.AddExtension(new Profile());

mark.Transform(text);

Пример блока для Python:

from timeit import Timer

tmp = "Python 3.2.2 (default, Jun 12 2011, 15:08:59) [MSC v.1500 32 bit (Intel)] on win32."

def case1(): # А. инкрементальные конкатенации в цикле
    s = ""
    for i in range(10000):
        s += tmp

def case2(): # Б. через промежуточный список и метод join
    s = []
    for i in range(10000):
        s.append(tmp)
    s = "".join(s)

def case3(): # В. списковое выражение и метод join
    return "".join([tmp for i in range(10000)])

def case4(): # Г. генераторное выражение и метод join
    return "".join(tmp for i in range(10000))

for v in range(1,5):
    print (Timer("func()","from __main__ import case%s as func" % v).timeit(200))

⬆️ Оглавление

Списки

Маркированный

Задать маркированный список можно несколькими символами -, + или *:

- Уровень списка 1. Пункт 1.
- Уровень списка 1. Пункт 2.
- Уровень списка 1. Пункт 3.
  • Уровень списка 1. Пункт 1.
  • Уровень списка 1. Пункт 2.
  • Уровень списка 1. Пункт 3.
+ Уровень списка 1. Пункт 1.
+ Уровень списка 1. Пункт 2.
+ Уровень списка 1. Пункт 3.
  • Уровень списка 1. Пункт 1.
  • Уровень списка 1. Пункт 2.
  • Уровень списка 1. Пункт 3.
* Уровень списка 1. Пункт 1.
* Уровень списка 1. Пункт 2.
* Уровень списка 1. Пункт 3.
  • Уровень списка 1. Пункт 1.
  • Уровень списка 1. Пункт 2.
  • Уровень списка 1. Пункт 3.

Можно создавать многоуровневые списки. Каждый уровень отделяется четырьмя (4) пробелами:

- Уровень списка 1. Пункт 1.
    - Уровень списка 2. Пункт 1.
- Уровень списка 1. Пункт 2.
    - Уровень списка 2. Пункт 1.
    - Уровень списка 2. Пункт 2.
- Уровень списка 1. Пункт 3.
    - Уровень списка 2. Пункт 1.
        - Уровень списка 3. Пункт 1.
        - Уровень списка 3. Пункт 2.
           - Уровень списка 4. Пункт 1.
  • Уровень списка 1. Пункт 1.
    • Уровень списка 2. Пункт 1.
  • Уровень списка 1. Пункт 2.
    • Уровень списка 2. Пункт 1.
    • Уровень списка 2. Пункт 2.
  • Уровень списка 1. Пункт 3.
    • Уровень списка 2. Пункт 1.
      • Уровень списка 3. Пункт 1.
      • Уровень списка 3. Пункт 2.
        • Уровень списка 4. Пункт 1.

Каждый уровень отделяется двумя пробелами.

Нумерованный

Для Githib работа с нумерованными списками выглядит очень интересно. Каждый уровень отделяется четырьмя (4) пробелами:

1. Первый уровень 1
    1. Второй уровень 1
        1. Третий уровень 1
            1. Четвертый уровень 1
                1. Пятый уровень 1
                    1. Шестой уровень
                        1. Седьмой уровень
                            1. Седьмой уровень
2. Первый уровень 2
2. Первый уровень (должно быть 3)
4. Первый уровень 4
  1. Первый уровень 1
    1. Второй уровень 1
      1. Третий уровень 1
        1. Четвертый уровень 1
          1. Пятый уровень 1
            1. Шестой уровень
              1. Седьмой уровень
                1. Седьмой уровень
  2. Первый уровень 2
  3. Первый уровень (должно быть 3)
  4. Первый уровень 4

Смешанные списки

При использовании смешанных списков нужно очень внимательно следить за нумерацией. Лучше, как и в нумерованных, использовать четыре (4) пробела для отделения уровня.

1. Первый уровень "нумерованный" - 1
    * Второй уровень "маркер"
        + Третий уровень "маркер"
        - Третий уровень "маркер"
        1. Третий уровень "нумерованный" - 1
            1. Четвертый уровень "нумерованный" - 1
                1. Пятый уровень "нумерованный" - 1
                    1. Шестой уровень "нумерованный" - 1
                        1. Седьмой уровень "нумерованный" - 1
                        * Седьмой уровень "маркер"
                        2. Седьмой уровень "нумерованный" - 1 (нарушена нумерация, новая нумерация 1)
                        3. Седьмой уровень "нумерованный" - 1 (нарушена нумерация, новая нумерация 2)
                            1. Восьмой уровень "нумерованный" - 1
2. Первый уровень "нумерованный" - 2
- Первый уровень "нумерованный" - 3
4. Первый уровень "нумерованный" - 4 (нарушена нумерация, новая нумерация 1)
5. Первый уровень "нумерованный" - 5 (нарушена нумерация, новая нумерация 2)
  1. Первый уровень "нумерованный" - 1
    • Второй уровень "маркер"
      • Третий уровень "маркер"
      • Третий уровень "маркер"
      1. Третий уровень "нумерованный" - 1
        1. Четвертый уровень "нумерованный" - 1
          1. Пятый уровень "нумерованный" - 1
            1. Шестой уровень "нумерованный" - 1
              1. Седьмой уровень "нумерованный" - 1
              • Седьмой уровень "маркер"
              1. Седьмой уровень "нумерованный" - 2
              2. Седьмой уровень "нумерованный" - 3
                1. Восьмой уровень "нумерованный" - 1
  2. Первый уровень "нумерованный" - 2
  • Первый уровень "маркерный" - 3
  1. Первый уровень "нумерованный" - 4 (хотя по идее должен быть 3)
  2. Первый уровень "нумерованный" - 5 (хотя, по идее должен быть 3)

Список задач

(Task List)Можно создавать "Списки задач" для этого необходимо использовать - [ ] для поставленной задачи и - [X] для выполненной задачи.

- [X] Придумать внешний вид резюме
- [ ] Написать основные категории
- [X] Опубликовать
  • Придумать внешний вид резюме
  • Написать основные категории
  • Опубликовать

Также можно создавать многоуровневые списки задач. Каждый уровень отделяется четырьмя (4) пробелами:

- [X] Задача 1
    - [X] Подзадача 1 для Задачи 1
    - [X] Подзадача 2 для Задачи 1
- [ ] Задача 2
    - [X] Подзадача 1 для Задачи 2
    - [ ] Подзадача 2 для Задачи 2
- [ ] Задача 3
    - [ ] Подзадача 1 для Задачи 3
        - [ ] Подзадача 1 для Подзадача 1 для Задачи 3
  • Задача 1
    • Подзадача 1 для Задачи 1
    • Подзадача 2 для Задачи 1
  • Задача 2
    • Подзадача 1 для Задачи 2
    • Подзадача 2 для Задачи 2
  • Задача 3
    • Подзадача 1 для Задачи 3
      • Подзадача 1 для Подзадача 1 для Задачи 3

⬆️ Оглавление

Ссылки

Либо просто вставить ссылку, либо дополнительно задать текст ссылки (пробела между скобками быть не должно):

Первый вариант вставки ссылок - это просто написать адрес сайта http://sabaka.net

Первый вариант вставки ссылок - это просто написать адрес сайта http://sabaka.net

Второй вариант записывается так: [текст ссылки](адрес ссылки)

[sabaka.net](http://sabaka.net)

sabaka.net

⬆️ Оглавление

Вставка изображения

![Alt-текст](https://avatars1.githubusercontent.com/u/5384215?v=3&s=460 "Орк")

Alt-текст

Дополнительно:

Вставка ссылки с картинкой на ролик с YouTube

Описание комбинации [![Тут текст](адрес до картинки)](ссылка на страничку YouTube)
Пример:
[![Тут текст](https://img.youtube.com/vi/RHPYGwVQB2o/0.jpg)](https://youtu.be/RHPYGwVQB2o)
Что мы увидим:
Тут текст

⬆️ Оглавление

Вставка таблиц

| LEFT | CENTER | RIGHT |
|----------------|:---------:|----------------:|
| По левому краю | По центру | По правому краю |
| текст | текст | текст |
LEFT CENTER RIGHT
По левому краю По центру По правому краю
текст текст текст

Внимание: Если в тексте таблицы нужно использовать символ "вертикальная черта - |", то в место него необходимо написать замену на комбинацию HTML-кода* &#124;, это нужно для того, что бы таблица не потеряла ориентации.
*) - Можно использовать ASCII и/или UTF коды.

Пример:

| Обозначение | Описание | Пример регулярного выражения|
|----:|:----:|:----------|
| literal | Строка содержит символьный литерал literal | foo |
| re1&#124;re2 | Строка содержит регулярные выражения `rel` или `re2` | foo&#124;bar |

Результат:

Обозначение Описание Пример регулярного выражения
literal Строка содержит символьный литерал literal foo
re1|re2 Строка содержит регулярные выражения rel или re2 foo|bar

⬆️ Оглавление

 使用案例
  • LoRDEC 0.5 - README file

     http://atgc.lirmm.fr/lordec/README.html LoRDEC 0.5 - README file 1 Overview Program for correcting sequencing errors in PacBio reads using highly accurate short reads (e.g. Illumina). 2 Reference L

  • README

    本Markdown编辑器使用StackEdit修改而来，用它写博客，将会带来全新的体验哦： 快捷键 加粗 Ctrl + B 斜体 Ctrl + I 引用 Ctrl + Q 插入链接 Ctrl + L 插入代码 Ctrl + K 插入图片 Ctrl + G 提升标题 Ctrl + H 有序列表 Ctrl + O 无序列表 Ctrl + U 横线 Ctrl + R 撤销 Ctrl + Z 重做 Ctr

  • NMEA-0183国外开源库源代码分析-README

    NMEA library NMEA库 Disclaimer 免责声明 The National Marine Electronics Association (NMEA) has developed a specification that defines the interface between various pieces of marine electronic equipment. Th

  • Bionic---The README from the bionic/libc

    Welcome to Bionic, Android's small and custom C library for the Android platform. Bionic is mainly a port of the BSD C library to our Linux kernel with the following additions/changes: - no support fo

  • github的readme编写格式

    CSDN 使用的格式和github的readme编写格式是一样的。 一、标题写法 第一种方法： 1、在文本下面加上 等于号 = ，那么上方的文本就变成了大标题。等于号的个数无限制，但一定要大于0个哦。。 2、在文本下面加上 下划线 - ，那么上方的文本就变成了中标题，同样的 下划线个数无限制。 3、要想输入=号，上面有文本而不让其转化为大标题，则需要在两者之间加一个空行。 另一种方法：（推荐这种方

 相关资料
  • format

    如前所述，Perl代表实用提取和报告语言，现在我们将讨论使用Perl编写报告。 Perl使用称为“格式”的书写模板来输出报告。 要使用Perl的格式功能，您必须 - 定义格式 传递将在格式上显示的数据 调用格式 定义格式 以下是定义Perl格式的语法 format FormatName = fieldline value_one, value_two, value_three f

  • format

    字符串的格式可以通过简单格式函数完成。 format函数使用java.lang.String.format.格式化字符串java.lang.String.format. 语法 (Syntax) 以下是语法。 (format fmt args) Parameters - 'fmt'是需要应用的格式。 'Args'是需要应用格式的参数。 Return Value - 返回值是一个字符串。 例子 (E

  • Format

    代码格式化 用法 $ fecs format [target...] $ fecs format [target...] --type=js,css 说明 使用 eslint与 esformatter 对 当前目录 下所有 JavaScript 代码进行格式化。 使用 csscomb 对 当前目录 下所有 CSS 代码进行格式化。 使用 https://www.wenjiangs.com/doc/

  • format

    import "go/format" Package format implements standard formatting of Go source.。 func Node(dst io.Writer, fset *token.FileSet, node interface{}) error func Source(src []byte) ([]byte, error) func Node

  • Text Format

    WebAssembly will define a standardized text format that encodes a WebAssembly module with all its contained definitions in a way that is equivalent to the binary format. This format will use S-express

  • d3-format

    有没有注意到, 有时候 JavaScript 对数字的显示方式与预想的不一样, 比如下面这个简单的循环： for (var i = 0; i < 10; i++) { console.log(0.1 * i); } 你会得到如下结果: 0 0.1 0.2 0.30000000000000004 0.4 0.5 0.6000000000000001 0.7000000000000001 0.8

  • d3-format

    有没有注意到, 有时候 JavaScript 对数字的显示方式与预想的不一样, 比如下面这个简单的循环： for (var i = 0; i < 10; i++) { console.log(0.1 * i); } 你会得到如下结果: 0 0.1 0.2 0.30000000000000004 0.4 0.5 0.6000000000000001 0.7000000000000001 0.8

  • Format Painter

    The Format Painter plugin allows a user to copy and paste formatting from one location to another, such as font style and size. The format painter is capable of working with a wide variety of formats

同类工具

padroes-de-commitsrails_emojingx-markdownEmojiVSemoji-extractoembed-jsEmoji-Logapple-emoji-linux

相关阅读

Python中format()格式输出全解“％s”％格式与“ {0}”。format（）与“？” 格式使用--format将'docker images'输出为jsonPython中格式化format()方法详解优化Vue中date format的性能详解

相关文章

相关问答

为什么“{x[1:3]}”。format（x=“asd”）`是否导致键入错误？google-java-format eclipse插件忽略格式化程序：关闭注释使用parse和format使用react-final-form和react-select的条件下拉列表php框架 - 阿里云OSS服务端签名前端JS直传 回调出错 Response body is not valid json format？

相关文档

快捷导航： 新手教程 算法原理 架构设计 Java进阶 数据库进阶 大厂专栏 面试经验 编程笔记 编程问答 所有专题 文档资料 工具软件 电子书籍 小牛导航
在线工具： 房贷计算器 个税计算器 Linux命令查询 Json格式化 正则表达式 颜色转换 AES加解密 SHA1加密 MD5加密 毒鸡汤 字数统计 随机密码生成 进制转换 Base64编解码 励志句子
Copyright © 2019-2024 小牛知识库@xnip.cn. All Rights Reserved.