Формирование и актуализация Markdown-исходников документации - История изменений

Sidminik: /* Файловая структура при документировании */

2026-05-13T07:36:19Z

Файловая структура при документировании

← Предыдущая версия		Версия от 07:36, 13 мая 2026
Строка 126:		Строка 126:

	Для удобства разработки документации, формирования понятной файловой структуры и корректного отображения содержимого генерируемой веб-страницы необходимо следовать следующим правилам:		Для удобства разработки документации, формирования понятной файловой структуры и корректного отображения содержимого генерируемой веб-страницы необходимо следовать следующим правилам:
	*~~Файлы~~, описывающие каждый раздел необходимо располагать согласно структуре оглавления		*файлы, описывающие каждый раздел необходимо располагать согласно структуре оглавления;
	*~~Для~~ каждого раздела создаётся директория; для корневых разделов директории с описанием находятся в корне проекта src		*для каждого раздела создаётся директория;
	*~~Если~~ раздел содержит подразделы, создаются поддиректории внутри раздела		*для корневых разделов директории с описанием находятся в корне проекта <code>src</code>;
	*В директории каждого раздела находятся файл с расширением .md, с документацией соответствующей главы		*если раздел содержит подразделы, создаются поддиректории внутри раздела;
	*~~Названия~~ всех папок и файлов должны быть без пробелов		*в директории каждого раздела находятся файл с расширением <code>.md</code>, с документацией соответствующей главы;
	*~~Если~~ раздел или подраздел содержит изображения, в соответствующей директории создаётся папка assets, в которой размещаются файлы изображений		*названия всех папок и файлов должны быть без пробелов;
	*~~Изображения~~ именуются как asset_1, asset_2, ... и т.д. в том порядке, в котором они расположены в разделе документации, к которому относятся		*если раздел или подраздел содержит изображения, в соответствующей директории создаётся папка <code>assets</code>, в которой размещаются файлы изображений;
			*изображения именуются как <code>asset_1</code>, <code>asset_2</code>, ... и т.д. в том порядке, в котором они расположены в разделе документации, к которому относятся.

	Ниже приведён пример оглавления в SUMMARY.md и соответствующая ему файловая структура		Ниже приведён ''пример оглавления'' в <code>SUMMARY.md</code> и соответствующая ему ''файловая структура''.

	~~Оглавление в SUMMARY~~.~~md:~~

	<syntaxhighlight lang="markdown">		<syntaxhighlight lang="markdown">

Sidminik: /* Файловая структура при документировании */

2026-05-13T07:31:59Z

Файловая структура при документировании

@@ Строка 124: / Строка 124: @@
 ==Файловая структура при документировании==
 Для удобства разработки документации, формирования понятной файловой структуры и корректного отображения содержимого генерируемой веб-страницы необходимо следовать следующим правилам:
 Ниже приведён пример оглавления в SUMMARY.md и соответствующая ему файловая структура

Sidminik: /* Элементы */

2026-05-13T07:29:51Z

Элементы

← Предыдущая версия		Версия от 07:29, 13 мая 2026
Строка 59:		Строка 59:
	*Глава-черновик,		*Глава-черновик,
	*Разделитель.		*Разделитель.

			----

	===Ненумерованные главы===		===Ненумерованные главы===
Строка 73:		Строка 75:

	'''Суффиксная глава''' - как и главы-префиксы, главы-суффиксы не нумеруются, но следуют после пронумерованных глав.		'''Суффиксная глава''' - как и главы-префиксы, главы-суффиксы не нумеруются, но следуют после пронумерованных глав.

			----

	===Ненумерованный заголовок первого уровня===		===Ненумерованный заголовок первого уровня===
Строка 86:		Строка 90:

	Заголовки частей должны быть заголовками уровня <code>h1</code> (один <code>#</code>), другие уровни заголовков игнорируются.		Заголовки частей должны быть заголовками уровня <code>h1</code> (один <code>#</code>), другие уровни заголовков игнорируются.

			----

	===Нумерованный заголовок===		===Нумерованный заголовок===
Строка 94:		Строка 100:

	Чтобы сделать нумерованную главу вложенной, к ссылке в начале добавляется табуляция		Чтобы сделать нумерованную главу вложенной, к ссылке в начале добавляется табуляция

			----

	===Глава-черновик===		===Глава-черновик===

	В <code>SUMMARY.md</code> таким главам соответствует ссылка с пустым путём к файлу с описанием.		В <code>SUMMARY.md</code> таким главам соответствует ссылка с пустым путём к файлу с описанием.

Строка 105:		Строка 114:

	Главы-черновики пишутся как обычные главы, но без записи пути к файлу		Главы-черновики пишутся как обычные главы, но без записи пути к файлу

			----

	===Разделитель===		===Разделитель===

Sidminik: /* Оглавление */

2026-05-13T07:28:32Z

Оглавление

← Предыдущая версия		Версия от 07:28, 13 мая 2026
Строка 5:		Строка 5:
	==Оглавление==		==Оглавление==

	'''Файл <code>SUMMARY.md</code>''' - необходим для формирования заголовков документации, их последовательности и иерархии.		'''Файл <code>SUMMARY.md</code>''' (оглавление) - необходим для формирования заголовков документации, их последовательности и иерархии.

	Файл является неотъемлемой частью документации и должен находиться только в корне проекта.		Файл является неотъемлемой частью документации и должен находиться только в корне проекта.

Sidminik: /* Ссылки */

2026-05-13T07:27:24Z

Ссылки

← Предыдущая версия		Версия от 07:27, 13 мая 2026
Строка 44:		Строка 44:
	[[Файл:Help_18.png\|center]]		[[Файл:Help_18.png\|center]]

	===Ссылки===		==Ссылки==
	'''Ссылки''' - являются основной структурной единицей оглавления и состоят из:		'''Ссылки''' - являются основной структурной единицей оглавления и состоят из:
	*''названия главы'' (подраздела) - в квадратных скобках,		*''названия главы'' (подраздела) - в квадратных скобках,
Строка 51:		Строка 51:
	'''Важно:''' для корректного отображения страницы при создании ссылок в пути к файлу необходимо использовать прямой слэш <code>/</code>.		'''Важно:''' для корректного отображения страницы при создании ссылок в пути к файлу необходимо использовать прямой слэш <code>/</code>.

	~~----~~		==Элементы==

	'''Элементы''', которые используются при создании оглавлений:		'''Элементы''', которые используются при создании оглавлений:

Sidminik: /* Элементы оглавления в SUMMARY.md */

2026-05-13T07:27:02Z

Элементы оглавления в SUMMARY.md

← Предыдущая версия		Версия от 07:27, 13 мая 2026
Строка 15:		Строка 15:
	Оглавление, описанное в <code>SUMMARY.md</code> состоит из элементов, каждый из которых определяет то, какой будет структура оглавления и каким будет контент каждой главы в итоговом документе.		Оглавление, описанное в <code>SUMMARY.md</code> состоит из элементов, каждый из которых определяет то, какой будет структура оглавления и каким будет контент каждой главы в итоговом документе.

	~~===Элементы оглавления в SUMMARY.md===~~
	Пример оглавления в <code>SUMMARY.md</code> может выглядеть следующим образом:		Пример оглавления в <code>SUMMARY.md</code> может выглядеть следующим образом:

Sidminik: /* Создание оглавления */

2026-05-13T07:26:46Z

Создание оглавления

← Предыдущая версия		Версия от 07:26, 13 мая 2026
Строка 3:		Строка 3:
	*распределение <code>.md</code> файлов в файловой структуре согласно иерархии.		*распределение <code>.md</code> файлов в файловой структуре согласно иерархии.

	==~~Создание оглавления~~==		==Оглавление==

	'''Файл <code>SUMMARY.md</code>''' - необходим для формирования заголовков документации, их последовательности и иерархии.		'''Файл <code>SUMMARY.md</code>''' - необходим для формирования заголовков документации, их последовательности и иерархии.

Sidminik: /* Разделитель */

2026-05-13T07:26:01Z

Разделитель

← Предыдущая версия		Версия от 07:26, 13 мая 2026
Строка 108:		Строка 108:

	===Разделитель===		===Разделитель===
	~~Разделитель добавляет полосу, отделяющую одну часть оглавления от другой~~
	Разделитель - это строка, содержащая три и более тире: ---		'''Разделитель''' - это строка, содержащая три и более тире: <code>---</code>.

			Разделитель добавляет полосу, отделяющую одну часть оглавления от другой.

	==Файловая структура при документировании==		==Файловая структура при документировании==

Sidminik: /* Глава-черновик */

2026-05-13T07:24:34Z

Глава-черновик

← Предыдущая версия		Версия от 07:24, 13 мая 2026
Строка 97:		Строка 97:

	===Глава-черновик===		===Глава-черновик===
	В SUMMARY.md таким главам соответствует ссылка с пустым путём к файлу с описанием		В <code>SUMMARY.md</code> таким главам соответствует ссылка с пустым путём к файлу с описанием.

	Главы-черновики - это главы без файла и, следовательно, контента. Обычно используются разметки структуры документа, когда отсутствует содержание глав. Такие главы отображаются как неактивные ссылки в оглавлении. Главы-черновики пишутся как обычные главы, но без записи пути к файлу		'''Главы-черновики''' - это главы без файла и, следовательно, контента.

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

			Такие главы отображаются как неактивные ссылки в оглавлении.

			Главы-черновики пишутся как обычные главы, но без записи пути к файлу

	===Разделитель===		===Разделитель===

Sidminik: /* Ненумерованный заголовок первого уровня */

2026-05-13T07:23:43Z

Ненумерованный заголовок первого уровня

← Предыдущая версия		Версия от 07:23, 13 мая 2026
Строка 78:		Строка 78:
	В <code>SUMMARY.md</code> таким заголовкам соответствует текст с одним знаком <code>#</code> в начале.		В <code>SUMMARY.md</code> таким заголовкам соответствует текст с одним знаком <code>#</code> в начале.

	Заголовки уровня 1 можно использовать в качестве заголовка для следующих пронумерованных глав.		Заголовки уровня <code>1</code> можно использовать в качестве заголовка для следующих пронумерованных глав.

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