Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Movable Type Wiki
branch: master
Failed to load latest commit information.
assets Update readme
common Update pages
examples Update pages
hosting Updated hosting media temple (markdown)
imports Updated wordpress to movabletype (markdown)
install Update pages
mtpro Update pages
other Update pages
plugins
tips Update pages
update Updated update movabletype (markdown)
Changelog.md Update pages
Home.md Update pages
README.md Update Readme
Versions.md Update pages

README.md

Публичный репозиторий для документации.

Как работать с документацией

Для работы с документацией достаточно сделать следующее:

1. Сделать форк репозитория с документацией

Для этого зайдите на страницу github.com/saahov/mt-wiki и нажмите на кнопку «Fork», как показано на этой картинке:

Fork

После этого в вашем аккаунте появится репозиторий, который будет привязан к этому.

2. Склонировать свой репозиторий на компьютер

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

git clone git@github.com:ваше_имя_пользователя/mt-wiki.git

В результате выполнения данной команды на вашем компьютере будет создан локальный репозиторий, в котором вы сможете редактировать и создавать файлы документации.

3. Отредактировать какие-либо файлы или добавить свои

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

Обратите внимание: Файлы документации должны быть с расширением .md. Это значит, что форматирование текста происходит в формате Markdown. Основные элементы форматирования с примерами есть в этом документе.

4. Отправка изменений в свой репозиторий

После того, как вы изменили документы, выполните следующие команды в терминале:

1). Добавление новых файлов:

git add .

2). Фиксация изменений:

git commit -a -m "Краткое описание изменений"

3). Отправка изменений в свой удалённый форк (в ветку master):

git push origin master

5. Интеграция изменений с основной документацией

Теперь, когда ваши изменения видны на Github, необходимо интегрировать их с основной документацией. Для это откройте страницу со своим репозиторием и нажмите на кнопку «Pull Request».

Pull

Откроется диалог запроса на интеграцию изменений. Здесь также необходимо указать краткое описание изменений. После отправки запроса в самое ближайшее время ваши изменения будут интегрированы.

Структура каталогов в документации

  • assets — статические файлы (картинки, скриншоты)
  • common — страницы об основных темах
  • examples — примеры шаблонов, различные хаки
  • hosting — статьи о хостинге для Movable Type
  • imports — статьи об импорте с других платформ
  • install — статьи об установке
  • mtpro — статьи о MT Pro
  • other — статьи мало относящиеся к MT
  • plugins — статьи о плагинах
  • tips — различные советы
  • update — статьи об обновлении

Рекомендации по стилю

Никаких особых требования к стилю нет. Но будет хорошо, если автор статей будет:

  • обращаться к читателю обезличенно;
  • в обращениях использовать «вы» вместо «ты».

Форматирование документов

Для форматирования текста используется синтаксис Markdown. Это достаточно простой синтаксис, который поддерживается большинством текстовых редакторов. Пример:

Редактирование документа

Рекомендуется использовать следующие параметры редактора:

  • Пробелы вместо табуляции;
  • Ширина табуляции — 4 пробела;
  • Кодировка — UTF-8.
  • Расширение документа — .md.

Примеры форматирования

# Заголовок документа (обязателен, иначе будет отображаться имя файла)

Текст документа.

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

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

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

* Первый элемент списка
* Второй элемент списка
* Третий элемент списка

1. Первый элемент нумерованного списка
2. Второй элемент нумерованного списка
3. Третий элемент нумерованного списка

> Текст цитаты

[текст для внешней ссылки](http://example.com/)

[[текст для внутренней ссылки|имя документа, на который будет ссылка]] — имя документа должно быть расширения.

**Текст, выделенный жирным**

_Текст, выделенный курсивом_

Подсветка кода на страницах

Примеры выделения кода:

1). Выделенный код в той же строке (например, так рекомендуется выделять все теги MT, пути, адрес URL в примерах):

`<mt:Example/>`

2) Блок кода с обеих сторон заключается тремя символами:


3) Для блока кода можно указывать определённый синтаксис:

Возможные примеры синтаксиса: xml (рекомендуется для тегов MT), html, perl, php, bash, apache, mysql, sql, js, css.

Something went wrong with that request. Please try again.