Базовая реализация колбы документации Docsify - PullRequest
Новая
       51

Базовая реализация колбы документации Docsify

1 голос
/ 01 июня 2019

Я наткнулся на Docsify (https://docsify.js.org/#/)) и с удовольствием поэкспериментировал с ним. Я заинтересован в том, чтобы обслуживать некоторую документацию, используя свой собственный флеш-сервер вместо Github Pages или с узлом, однако я не могу понять как это осуществить.

Как описано Docsify (https://docsify.js.org/#/quickstart?id=manual-initialization),, локально обслуживающий простой index.html для рендеринга и README.md в качестве содержимого уценки, работает прекрасно.

index.html

<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
  <div id="app"></div>
  <script>
    window.$docsify = {
      //...
    }
  </script>
  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</body>
</html>

README.md

# Hi, I'm markdown content

Командная строка для запуска статического сервера (работает): 

python -m SimpleHTTPServer 3000

Теперь, во Flask, я использую фабрику приложений + шаблон чертежей, и что касается колбы, все работает как положено. Я могу добавить новую конечную точку, и она прекрасно отрисовывается. Моя файловая структура: 

├── instance
│   └── flask.cfg
├── main.py
├── project
│   ├── __init__.py
│   ├── front
│   │   ├── __init__.py
│   │   ├── routes.py
│   │   └── templates
│   │       └── front
│   │           └── index.html
│   ├── documentation
│   │   ├── __init__.py
│   │   ├── routes.py
│   │   └── templates
│   │       └── documentation
│   │           ├── README.md
│   │           └── index.html
│   ├── static
│   │   ├── favicon.ico
│   │   └── style.css
│   └── templates
│       └── base.html
└── requirements.txt

В папке project -> documentation -> documentation я добавляю README.md на том же уровне, что и в предыдущем примере Docsify, который так хорошо обслуживается локально.

index.html загружается через флягу (посмотрите внимательно, и вы увидите боковую панель и кнопку меню гамбургера), но содержание уценки нет, и я получаю сообщение «404 - Не найдено». docsify 404

Я просто не знаю, как это реализовать, не говоря уже о том, как сделать это элегантно.

...