Skip to content

Commit

Permalink
feat(gh-page): zero effort gh-page from readme with docsify (#298)
Browse files Browse the repository at this point in the history
feat(gh-page): zero effort gh-page not requiring copy of README.md into docs directory

fix: gh-page title

fix: remove search because it does not work with remote markdown
  • Loading branch information
casaper committed Feb 4, 2021
1 parent 47d1e1b commit 29b45a0
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
Empty file added docs/.nojekyll
Empty file.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[remoteMarkdownUrl](https://raw.githubusercontent.com/you-dont-need/You-Dont-Need-Lodash-Underscore/master/README.md)
35 changes: 35 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>You don’t (may not) need Lodash/Underscore</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
name: 'You don\'t need Lodash',
nameLink: '/',
repo: 'https://github.com/you-dont-need/You-Dont-Need-Lodash-Underscore',
autoHeader: true,
maxLevel: 3,
markdown: {
smartypants: true
},

remoteMarkdown: {
tag: 'remoteMarkdownUrl',
},
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify-remote-markdown/dist/docsify-remote-markdown.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-js-extras.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-js-templates.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-jsdoc.min.js"></script>
</body>
</html>

0 comments on commit 29b45a0

Please sign in to comment.