1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/honeymoose-docker-docs

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
test.md 26 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 30.11.2024 06:16 d895bcf

Страница тестирования Docker документации

Добро пожаловать на тестовую страницу документации Docker!

Это демонстрация компонентов, тегов, стилей, инструментов и стратегий, которые мы используем для создания документации. Мы объясняем код, стоящий за опубликованной страницей, и демонстрируем эффекты. Так что, если вы хотите увидеть, например, как в markdown реализованы предупреждения и примечания, прочитайте раздел «Предупреждения (примечания)» на опубликованной веб-странице и изучите предварительно обработанный файл test.md, чтобы понять, как они реализованы. Команда Docker Documentation использует эту страницу как напоминание для себя. Поскольку мы приглашаем сообщество к предложениям и вкладам в документацию, мы всегда делали тестовую страницу общедоступной.

Если вы хотите понять, как что-то реализовано в документации, используйте эту страницу в качестве ресурса.

Если в процессе обновления документации или внесения предложений вы разработаете новую стратегию или компонент для документации, не стесняйтесь добавить демонстрацию и объяснение на эту тестовую страницу и отправить PR, чтобы мы могли рассмотреть и обсудить его.

Здорово? Давайте погрузимся!

Заголовок 1

Большинство страниц фактически не имеют заголовка H1. Заголовок страницы из метаданных автоматически вставляется. Мы включили его здесь, чтобы показать все уровни заголовков и установили front matter как toc_min: 1, чтобы он отображался в навигационной панели (на странице).

Заголовок 2

По умолчанию это самый высокий заголовок, включенный в правую навигационную панель. Чтобы включить больше уровней заголовков, установите toc_min: 1 в front-matter страницы (как это сделано на этой странице test.md). Вы можете дойти до 6, но если toc_min больше toc_max, то заголовки не отображаются.

Заголовок 3

Это самый низкий заголовок, включённый в правую навигацию, по умолчанию. Чтобы включить больше уровней заголовков, установите toc_max: 4 в front-matter страницы. Вы можете дойти до 6.


Текст продолжается в том же духе. Область разработки и тестирования программного обеспечения

{% capture my-other-text %}foo{% endcapture %} Here is another way: {{ my-other-text }}

You can nest captures within each other to represent more complex logic with Liquid.

Liquid variable scope

  • Вещи, заданные на верхнем уровне _config.yml, доступны как переменные сайта, например {{ site.debug }}.
  • Вещи, установленные в метаданных страницы, либо через значения по умолчанию в _config.yml, либо для каждой страницы, доступны как переменные страницы, например {{ page.title }}.
  • Встроенные переменные, установленные с помощью assign или capture, доступны до конца страницы после их установки.
  • Если вы включаете файл, вы можете одновременно передавать пары ключ-значение. Они доступны как включаемые переменные, такие как {{ include.toc_min }}.

Форматирование изображений

Это изображение изначально было создано на белом фоне и преобразовано в прозрачный фон (или так кажется). В ночном режиме текст всё ещё показывает следы белого и выглядит искажённым. Чтобы исправить это, мы применяем белый фон вместе с классом, определённым в _scss/_night-mode.css (и включённым в style.css): img.white-bg { background-color: white; }.

alt_text{: .white-bg}

Bootstrap и CSS трюки

Вот интересные компоненты, которые вы можете включить на страницах Docs, используя Bootstrap и CSS.

Таблицы

Вот несколько таблиц:

TAB 1 CONTENT
TAB 2 CONTENT

Вам нужно настроить значения id и data-target, чтобы они соответствовали вашему варианту использования.

<hr> включены просто для добавления визуального разделения между содержимым с вкладками и другими темами на странице.

Если у вас есть Markdown внутри содержимого <div>, просто добавьте markdown="1" в качестве атрибута в HTML для <div>, чтобы Kramdown отображал его.

#### Заголовок Markdown
  • элемент списка 1
  • элемент списка 2

#### Ещё один заголовок Markdown
  • элемент списка 3
  • элемент списка 4

Синхронизация нескольких групп таблиц

Рассмотрим пример, когда у вас что-то вроде одной вкладки на язык, и у вас есть несколько таких наборов вкладок на странице. Вы можете захотеть, чтобы все они переключались вместе. У нас есть Javascript, который загружается на каждую страницу, что позволяет вам сделать это, установив атрибуты data-group одинаковыми. Атрибуты data-target по-прежнему должны указывать на уникальные идентификаторы div.

В этом примере выбор «Go» или «Python» в одном наборе вкладок переключает другой набор вкладок, чтобы соответствовать.

Содержимое Go
Содержимое Python

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

Содержание Go
Содержание Python

Карты

Во вставке Bootstrap столбцы должны составлять в сумме 12. Вот три карты в ряду, каждая из которых занимает 1/3 (4/12) строки. Вам нужно добавить пару <br />, чтобы очистить строку перед этим.

Разверните/сверните аккордеоны

Вы можете использовать Bootstrap и CSS для добавления аккордеонов с функцией развёртывания/сворачивания. В этой реализации используются классы .panel-heading в файле _utilities.scss и значки FontAwesome:

  • (fa-caret-down);
  • (fa-caret-up).

Добавление block к классу div collapse даёт отступы вокруг примера содержимого. Это хорошо работает для обычного текста. Если у вас есть пример кода, отступы отображаются как пробелы вокруг серого фона блока кода. Если нам не нравится этот эффект, мы можем удалить block для примеров кода.

Тег style="cursor: pointer" позволяет функции развёртывания/свертывания работать на мобильных устройствах. (Вы можете использовать симулятор iPhone Xcode, чтобы протестировать его на мобильном устройстве.)

Существует множество примеров аккордеонов Bootstrap. Мы использовали эту модель: PPxOJX образец аккордеона с HTML и CSS. (Вот ещё один пример, но он использует JavaScript, тогда как реализация, показанная здесь, использует только Bootstrap и CSS.)

Убедитесь, что data-target и id совпадают и являются уникальными.

Для каждого раскрывающегося списка значение data-target и класс collapse id должны совпадать, а идентификаторы должны быть уникальными для каждой страницы. В этом примере мы называем их collapseSample1 и collapseSample2. Посмотрите пример структуры файла Compose ([compose/compose-file/index.md#compose-file-structure-and-examples]), чтобы увидеть другой пример. {: .important-vanilla}

Пример Docker hello-world

$ docker run hello-world
Unable to find image 'hello-world:latest' locally
latest: Pulling from library/hello-world
b04784fba78d: Pull complete
Digest: sha256:f3b3b28a45160805bb16542c9531888519430e9e6d6ffc09d72261b0d26ff74f
Status: Downloaded newer image for hello-world:latest
Hello from Docker!
This message shows that your installation appears to be working correctly.
To generate this message, Docker took the following steps:

The Docker client contacted the Docker daemon.
The Docker daemon pulled the "hello-world" image from the Docker Hub.
The Docker daemon created a new container from that image which runs the
executable that produces the output you are currently reading.
The Docker daemon streamed that output to the Docker client, which sent it
to your terminal.

Чтобы попробовать что-то более амбициозное, вы можете запустить контейнер Ubuntu с помощью:
$ docker run -it ubuntu bash
Делитесь изображениями, автоматизируйте рабочие процессы и многое другое с бесплатным Docker ID:
https://hub.docker.com/
Дополнительные примеры и идеи см. по адресу:
https://docs.docker.com/engine/userguide/
Другой пример
### Текст запроса

Columnar text

Вы можете использовать CSS-свойство column-count для того, чтобы разбить текст на несколько колонок. Перед этим необходимо добавить пару тегов <br /> для очистки строки.

Этот пример использует HTML-элемент div. Этот пример использует HTML-элемент div. Этот пример использует HTML-элемент div. Этот пример использует HTML-element div. Этот пример использует HTML-element div. Этот пример использует HTML-element div.

Этот пример реализован с использованием Markdown. Нельзя добавлять пустые строки, иначе блок Markdown будет разбит.

{: style="column-count: 3 "}

Badges

Можно использовать значки (badges). Также можно использовать жёлтые значки (badge badge-warning) или красные значки (badge badge-danger).

Значки как ссылки

Значок можно сделать ссылкой. Оберните <span> тегом <a> (не наоборот), чтобы текст на значке оставался белым.

<a href="/test/" target="_blank" rel="noopener" class="_"><span class="badge badge-info" data-toggle="tooltip" data-placement="right" title="Open the test page (in a new window)">Test</span></a>

Также на значки можно добавить всплывающие подсказки (tooltips). Подробнее о них читайте далее.

Tooltips

Чтобы добавить всплывающую подсказку к любому элементу, установите data-toggle="tooltip" и задайте атрибут title. При наведении указателя мыши на элемент он станет видимым. Всплывающие подсказки не видны на мобильных устройствах или сенсорных экранах, поэтому не полагайтесь на них как на единственный способ передачи важной информации.

<span class="badge badge-info" data-toggle="tooltip" data-placement="right" title="Open the test page">Test</span>

Атрибут data-placement можно дополнительно установить в значение top, bottom, middle, center, left или right. Устанавливайте его только в том случае, если без него возникают проблемы с макетом.

HTML использовать необязательно. Атрибуты также можно задать с помощью Markdown.

This is a paragraph that has a tooltip. We position it to the left so it doesn't align with the middle top of the paragraph (that looks weird).
{:data-toggle="tooltip" data-placement="left" }
``` Заголовок: «Пример всплывающей подсказки Markdown»

Это абзац с всплывающей подсказкой. Мы размещаем её слева, чтобы она не выравнивалась по середине верхней части абзаца (это выглядит странно). {:data-toggle="tooltip" data-placement="left" title="Пример всплывающей подсказки Markdown"}

Выполнение встроенного JavaScript

Если вам нужно запустить пользовательский JavaScript на странице и он зависит от JQuery или Bootstrap, убедитесь, что теги <script> находятся в самом конце страницы, после всего содержимого. В противном случае скрипт может попытаться запуститься до загрузки JQuery и Bootstrap JS.

Примечание: В целом это плохая идея.

Предупреждения (примечания)

Текущие стили для предупреждений в _scss/_notes.scss поддерживают следующие категории предупреждений:

  • Примечания (тег Liquid не требуется) (устарело);
  • Важное, которое использует тег {: .important};
  • Предупреждение, которое использует тег {: .warning}.

Новые стили включают добавленные значки, цветные боковые панели и жирные цветные заголовки для многострочных примечаний, но без автоматического добавления текста. Они определены таким образом, чтобы не влиять на предупреждения, оформленные в исходном стиле, поэтому примечания в опубликованных документах не пострадают.

Примеры приведены в следующих разделах.

Примечание (Устарело)

Примечания устарели и больше не должны использоваться. Вместо них следует использовать важное или предупреждение.

Стандартное примечание оформляется следующим образом:

> Обработка временных ошибок
>
> Обратите внимание на способ написания функции `get_hit_count`. Этот базовый цикл повтора позволяет нам пытаться выполнить запрос несколько раз, если служба redis недоступна. Это полезно при запуске, когда приложение выходит в онлайн, а также делает наше приложение более устойчивым, если службу Redis необходимо перезапустить в любой момент времени работы приложения. В кластере это также помогает обрабатывать кратковременные разрывы соединения между узлами.

Оно отображается так с цветной боковой панелью и значком:

Пример примечания

Ранее примечания оформлялись следующим образом:

> **Примечание**: Это примечание, использующее старый стиль примечания.

Они по-прежнему будут отображаться как примечание с цветной боковой панелью слева, но значок добавлен не будет.

Важное

Добавьте класс important к своим блочным кавычкам, если хотите предупредить пользователей о чём-то:

> Тссс, хочешь знать кое-что?
>
> Вы включаете здесь небольшое описание, говорящее пользователям быть начеку
{: .important}

Он отображается так с цветной боковой панелью и значком:

Важное предупреждение

Предупреждение

Используйте класс warning, чтобы люди знали, что это опасно или они должны обратить пристальное внимание на эту часть дороги, прежде чем двигаться дальше:

> Ой, не делай этого!
>
> Сунуть палец в электрическую розетку может привести к удару током.
>
> Здесь вы также можете добавить больше абзацев, если ваше объяснение очень сложное.
{: .warning}

Отображается так с цветной боковой панелью и значком:

Предупреждение

Блоки кода

Rouge предоставляет множество различных блоков кода «подсказок». Если вы не укажете подсказку, он попытается угадать, и иногда это получается неправильно. Вот лишь некоторые из подсказок, которые мы часто используем.

Необработанный, без выделения

Необработанная разметка необходима, чтобы Liquid не интерпретировал вещи с двойными фигурными скобками как язык шаблонов.

{% raw %}

none с необработанным
$ some command with {{double braces}}
$ some other command

{% endraw %}

Необработанный, Bash

{% raw %}

bash с необработанным
$ some command with {{double braces}}
$ some other command

{% endraw %}

Bash

$ echo "deb https://packages.docker.com/1.12/apt/repo ubuntu-trusty main" | sudo tee /etc/apt/sources.list.d/docker.list

Go

incoming := map[string]interface{}{
    "asdf": 1,
    "qwer": []interface{}{},
    "zxcv": []interface{}{
        map[string]interface{}{},
        true,
        int(1e9),
        "tyui",
    },
}

PowerShell

Install-Module DockerMsftProvider ### PowerShell

```powershell
Install-Package Docker -ProviderName DockerMsftProvider -Force

PowerShell

[System.Environment]::SetEnvironmentVariable("DOCKER_FIPS", "1", "Machine")

PowerShell

Expand-Archive docker-18.09.1.zip -DestinationPath $Env:ProgramFiles -Force

Python

return html.format(name=os.getenv('NAME', "world"), hostname=socket.gethostname(), visits=visits)

Ruby

docker_service 'default' do
  action [:create, :start]
end

JSON

"server": {
  "http_addr": ":4443",
  "tls_key_file": "./fixtures/notary-server.key",
  "tls_cert_file": "./fixtures/notary-server.crt"
}

HTML

<!DOCTYPE html>
<html>
<head>
<title>Welcome to nginx!</title>
</head>
</html>

Markdown

# Hello

ini

[supervisord]
nodaemon=true

[program:sshd]
command=/usr/sbin/sshd -D

Dockerfile

#
# example Dockerfile for https://docs.docker.com/examples/postgresql_service/
#

FROM ubuntu

RUN apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys B97B0AFCAA1A47F044F244A07FCC7D46ACCC4CF8

RUN echo "deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main" > /etc/apt/sources.list.d/pgdg.list

RUN apt-get update && apt-get install -y python-software-properties software-properties-common postgresql-9.3 postgresql-client-9.3 postgresql-contrib-9.3

# Note: The official Debian and Ubuntu images automatically ``apt-get clean``
# after each ``apt-get``

USER postgres

RUN    /etc/init.d/postgresql start &&\
    psql --command "CREATE USER docker WITH SUPERUSER PASSWORD 'docker';" &&\
    createdb -O docker docker

RUN echo "host all  all    0.0.0.0/0  md5" >> /etc/postgresql/9.3/main/pg_hba.conf

RUN echo "listen_addresses='*'" >> /etc/postgresql/9.3/main/postgresql.conf

EXPOSE 5432

VOLUME  ["/etc/postgresql", "/var/log/postgresql", "/var/lib/postgresql"]

CMD ["/usr/lib/postgresql/9.3/bin/postgres", "-D", "/var/lib/postgresql/9.3/main", "-c", "config_file=/etc/postgresql/9.3/main/postgresql.conf"]

YAML

authorizedkeys:
  image: dockercloud/authorizedkeys
  deployment_strategy: every_node
  autodestroy: always
  environment:
    - AUTHORIZED_KEYS=ssh-rsa AAAAB3Nsomelongsshkeystringhereu9UzQbVKy9o00NqXa5jkmZ9Yd0BJBjFmb3WwUR8sJWZVTPFL
  volumes:
    /root:/user:rw

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/honeymoose-docker-docs.git
git@api.gitlife.ru:oschina-mirror/honeymoose-docker-docs.git
oschina-mirror
honeymoose-docker-docs
honeymoose-docker-docs
master