docute
docute copied to clipboard
egoist
Ability for a standalone file:// is broken
Hello!
I have documentation for my project at this repository that I gradually porting from a raw HTML into Docute: https://github.com/WohlSoft/PGE-Editor-Help/tree/docute
However, since some moment it no more works locally and it showing blank pages... (no idea how it worked before, maybe after Firefox 68 release).
I did an attempt to disable CORS:
fetchOptions: {
mode: 'no-cors',
},
however, it now showing just blank files. The source path I use just "./".
How I did use this?
- I had to use the latest master state.
- I did the
npm install, and thennpm run-script buildat repository root. - I copied "dist" and "lib" directories into the separate folder at my documentation root (_lib sub-directory).
- I did the simple HTML file to carry the documentation:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>Moondust Editor - Manual</title>
<link rel="stylesheet" href="_lib/docute/dist/docute.css">
<link rel="stylesheet" href="style.css">
</head>
<body>
<div id="docute"></div>
<script src="_lib/docute/dist/docute.js"></script>
<script src="index.js"></script>
</body>
</html>
- In
index.jsI had to declare the documentation tree itself:
let docuteSourceRoot = './';
new Docute({
target: '#docute',
title: 'Moondust Editor - Documentation',
sourcePath: docuteSourceRoot,
darkThemeToggler: true,
fetchOptions: {
mode: 'no-cors',
},
detectSystemDarkTheme: true,
highlight: ['typescript', 'bash'],
editLinkBase: 'https://github.com/WohlSoft/PGE-Editor-Help/edit/master/',
editLinkText: 'Edit this page on GitHub',
sidebar: [
{
title: 'Main',
children: [
{
title: 'Intro',
link: '/'
}
]
}
});
There doesn't seem be a README.md which it was trying to load in your repo? What's the error shown in your devtools?
A minimal reproduction would help, you can create one with https://codesandbox.io
Hello! It's a minimal example: docute-issue282-sample.zip
I had to store all pre-built dependencies at the _lib folder and re-using it locally.
It works if it stored on a web server and accessed via HTTP(S), however, when I opening "ko.html" from a local file system directly (accessed via file://), pages showing blank.
In Firefox's console here is no output. Before a moment, I had error against CORS request, however when I had to set the "no-cors", an error has gone, however, no content shown...
AHA! in Yandex-Browser I got the next error:
Fetch API cannot load file:///..../README.md. URL scheme "file" is not supported.
How my example works when it's opened locally without any sort of web server:
