Skip to content

Latest commit

 

History

History
467 lines (336 loc) · 10 KB

configuration.md

File metadata and controls

467 lines (336 loc) · 10 KB
Raw

Конфигурация

Вы можете настроить window.$docsify.

<script>
  window.$docsify = {
    repo: 'QingWei-Li/docsify',
    maxLevel: 3,
    coverpage: true
  }
</script>

el

  • Type: String
  • Default: #app

Элемент DOM должен быть установлен при инициализации. Это может быть строка селектора CSS или фактический элемент HTMLElement.

window.$docsify = {
  el: '#app'
};

repo

  • Type: String
  • Default: null

Настройте URL-адрес репозитория или строку username/repo, чтобы добавить виджет GitHub Corner в верхнем правом углу сайта.

window.$docsify = {
  repo: 'QingWei-Li/docsify',
  // или
  repo: 'https://github.com/QingWei-Li/docsify/'
};

maxLevel

  • Type: Number
  • Default: 6

Таблица максимального уровня вложенности контента.

window.$docsify = {
  maxLevel: 4
};

loadNavbar

  • Type: Boolean|String
  • Default: false

Загружает навигационную панель из файла Markdown _navbar.md, если true, или из указанного пути.

window.$docsify = {
  // загрузить из _navbar.md
  loadNavbar: true,

  // загрузить из nav.md
  loadNavbar: 'nav.md'
};

loadSidebar

  • Type: Boolean|String
  • Default: false

Загружает боковую панель из файла Markdown _sidebar.md, если **true **, или из указанного пути.

window.$docsify = {
  // загрузить из _sidebar.md
  loadSidebar: true,

  // загрузить из summary.md
  loadSidebar: 'summary.md'
};

subMaxLevel

  • Type: Number
  • Default: 0

Максимальный уровень вложенности оглавления в Sidebar панели.

window.$docsify = {
  subMaxLevel: 2
};

auto2top

  • Type: Boolean
  • Default: false

Прокручивается к верхней части экрана, когда маршрут изменяется.

window.$docsify = {
  auto2top: true
};

homepage

  • Type: String
  • Default: README.md

README.md в папке ваших документов будет рассматриваться как домашняя страница вашего веб-сайта, но иногда вам может понадобиться использовать другой файл в качестве домашней страницы.

window.$docsify = {
  // Поменять на /home.md
  homepage: 'home.md',

  // Или использовать readme из вашего репозитория
  homepage:
    'https://raw.githubusercontent.com/QingWei-Li/docsify/master/README.md'
};

basePath

  • Type: String

Базовый путь веб-сайта. Вы можете установить его в другой каталог или другое доменное имя.

window.$docsify = {
  basePath: '/path/',

  // Загрузите файлы с другого сайта
  basePath: 'https://docsify.js.org/',

  // Даже может загружать файлы из другого репозитория
  basePath:
    'https://raw.githubusercontent.com/ryanmcdermott/clean-code-javascript/master/'
};

coverpage

  • Type: Boolean|String|String[]|Object
  • Default: false

Активирует функцию обложки. Если значение true, оно будет загружаться из _coverpage.md.

window.$docsify = {
  coverpage: true,

  // кастомный файл 
  coverpage: 'cover.md',

  // множество обложек
  coverpage: ['/', '/zh-cn/'],

  // множество обложек и кастомный файл
  coverpage: {
    '/': 'cover.md',
    '/zh-cn/': 'cover.md'
  }
};

name

  • Type: String

Название сайта, как показано на боковой панели.

window.$docsify = {
  name: 'docsify'
};

nameLink

  • Type: String
  • Default: window.location.pathname

Имя ссылки.

window.$docsify = {
  nameLink: '/',

  // Для каждого маршрута
  nameLink: {
    '/zh-cn/': '/zh-cn/',
    '/': '/'
  }
};

markdown

  • Type: Function

Смотрите Markdown конфигурацию.

window.$docsify = {
  // object
  markdown: {
    smartypants: true,
    renderer: {
      link: function() {
        // ...
      }
    }
  },

  // function
  markdown: function(marked, renderer) {
    // ...
    return marked;
  }
};

themeColor

  • Type: String

Настройте цвет темы. Использование функции и полифилов CSS3 переменных в старом браузере.

window.$docsify = {
  themeColor: '#3F51B5'
};

alias

  • Type: Object

Установите псевдоним маршрута. Вы можете свободно управлять правилами маршрутизации. Поддерживает RegExp.feature и polyfill в старом браузере.

window.$docsify = {
  alias: {
    '/foo/(+*)': '/bar/$1', // supports regexp
    '/zh-cn/changelog': '/changelog',
    '/changelog':
      'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG',
    '/.*/_sidebar.md': '/_sidebar.md' // See #301
  }
};

autoHeader

  • type: Boolean

Если loadSidebar и autoHeader включены, для каждой ссылки в _sidebar.md, добавьте заголовок страницы, прежде чем преобразовать его в html. Подробнее #78.

window.$docsify = {
  loadSidebar: true,
  autoHeader: true
};

executeScript

  • type: Boolean

Выполняет скрипт на странице. Разбирает только первый тёг скрипта ([demo] (themes)). Если Vue присутствует, он включается по умолчанию.

window.$docsify = {
  executeScript: true
};
## Это тест

<script>
  console.log(2333)
</script>

Обратите внимание: если вы используете внешний скрипт, например, встроенная демонстрация jsfiddle, обязательно включите плагин external-script.

noEmoji

  • type: Boolean

Отключает emoji парсинг.

window.$docsify = {
  noEmoji: true
};

mergeNavbar

  • type: Boolean

Navbar будет объединен с боковой панелью на меньших экранах.

window.$docsify = {
  mergeNavbar: true
};

formatUpdated

  • type: String|Function

Вы можете отобразить дату обновления файла с помощью переменной {docsify-updated }. И форматируйте его formatUpdated. Смотрите https://github.com/lukeed/tinydate#patterns

window.$docsify = {
  formatUpdated: '{MM}/{DD} {HH}:{mm}',

  formatUpdated: function(time) {
    // ...

    return time;
  }
};

externalLinkTarget

  • type: String
  • default: _blank

Target внешние ссылки. По умолчанию '_blank' (new window/tab)

window.$docsify = {
  externalLinkTarget: '_self' // default: '_blank'
};

routerMode

  • type: String
  • default: history
window.$docsify = {
  routerMode: 'history' // default: 'hash'
};

noCompileLinks

  • type: Array

Иногда мы не хотим, чтобы docsify обрабатывал наши ссылки. Смотрите #203

window.$docsify = {
  noCompileLinks: ['/foo', '/bar/.*']
};

onlyCover

  • type: Boolean

При посещении главной страницы загружается только обложка.

window.$docsify = {
  onlyCover: false
};

requestHeaders

  • type: Object

Задаёт заголовок запроса ресурсов.

window.$docsify = {
  requestHeaders: {
    'x-token': 'xxx'
  }
};

ext

  • type: String

Расширение файла запроса.

window.$docsify = {
  ext: '.md'
};

fallbackLanguages

  • type: Array<string>

Список языков, которые будут возвращаться к языку по умолчанию, когда запрашиваемая страница не существует для данных локально.

Например:

  • сначала попробует получить страницу /de/overview. Если эта страница существует, она будет отображаться
  • затем попробует получить страницу по умолчанию /overview (в зависимости от языка по умолчанию). Если эта страница существует, она будет отображаться
  • затем отобразит страницу 404.  
window.$docsify = {
  fallbackLanguages: [
    "ru",
    "de"
  ]
};

notFoundPage

  • type: Boolean | String | Object

Загружает файл _404.md:

window.$docsify = {
  notFoundPage: true
};

Загрузит путь пользовательской страницы 404:

window.$docsify = {
  notFoundPage: 'my404.md'
};

Загрузит страницу 404 в соответствии с локализацией:

window.$docsify = {
  notFoundPage: {
    '/': '_404.md',
    '/ru': 'ru/_404.md',
  }
};

Примечание: Параметры fallbackLanguages не работают с параметрами notFoundPage.