Skip to content

Commit 398cdd7

Browse files
norajnoraj
committed
doc theme update
1 parent 43dac9a commit 398cdd7

18 files changed

+45
-12
lines changed

Diff for: ‎docs/CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
## [Unreleased]
22

3+
- Documentation:
4+
- Add bash syntax highlight support
5+
- Update docsify, docsify plugins
6+
- Change of docsify theme
7+
- Include version number in docsify scripts and themes as well as CDN url for easier update
38
- Chore:
49
- Change the way version is included. Insted of including a module `Version`, directly add the `VERSION` constant in the `PassStation` module. It could avoid namespace collision with that kind of generic name.
510

Diff for: ‎docs/_coverpage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
> CLI & library to search for default credentials among thousands of Products / Vendors
66
7-
[GitHub](https://github.com/noraj/pass-station)
87
[Get Started](pages/quick-start?id=quick-start)
8+
[GitHub](https://github.com/noraj/pass-station)
99

1010
![color](#101011)

Diff for: ‎docs/index.html

+17-6
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,14 @@
44
<meta charset="UTF-8">
55
<title>Document</title>
66
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7-
<meta name="description" content="Description">
7+
<meta name="description" content="Pass Station tool documentation">
88
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
9-
<link rel="stylesheet" href="vendor/themes/dark.css">
9+
<!-- Site theme -->
10+
<link rel="stylesheet" media="(prefers-color-scheme: dark)" href="vendor/themes/docsify-themeable-dark-0.9.0.min.css" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/theme-simple-dark.css.map">
11+
<link rel="stylesheet" media="(prefers-color-scheme: light)" href="vendor/themes/docsify-themeable-light-0.9.0.min.css" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/theme-simple.css.map">
12+
<!-- PrismJS theme -->
13+
<link rel="stylesheet" media="(prefers-color-scheme: dark)" href="vendor/prismjs/themes/prism-one-dark-1.9.0.min.css" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/themes/prism-one-dark.min.css">
14+
<link rel="stylesheet" media="(prefers-color-scheme: light)" href="vendor/prismjs/themes/prism-one-light-1.9.0.min.css" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/themes/prism-one-light.min.css">
1015
</head>
1116
<body>
1217
<div id="app"></div>
@@ -24,9 +29,15 @@
2429
onlyCover: true,
2530
}
2631
</script>
27-
<script src="vendor/docsify.js"></script>
28-
<script src="vendor/plugins/search.min.js"></script>
29-
<script src="vendor/plugins/emoji.min.js"></script>
30-
<script src="vendor/prismjs/components/prism-ruby.min.js"></script>
32+
<!-- Docsify -->
33+
<script src="vendor/docsify-4.13.1.js" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/lib/docsify.min.js"></script>
34+
<!-- Docsify plugins -->
35+
<script src="vendor/plugins/search-4.13.1.min.js" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/lib/plugins/search.min.js"></script>
36+
<script src="vendor/plugins/emoji-4.13.1.min.js" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/lib/plugins/emoji.min.js"></script>
37+
<!-- Docsify theme additions -->
38+
<script src="vendor/themes/docsify-themeable-0.9.0.min.js" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/docsify-themeable.min.js"></script>
39+
<!-- Docsify Syntax highlight languages -->
40+
<script src="vendor/prismjs/components/prism-bash-1.29.0.min.js" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/components/prism-bash.min.js"></script>
41+
<script src="vendor/prismjs/components/prism-ruby-1.29.0.min.js" data-cdn="https://cdn.jsdelivr.net/npm/[email protected]/components/prism-ruby.min.js"></script>
3142
</body>
3243
</html>

Diff for: ‎docs/vendor/docsify-4.13.1.js

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎docs/vendor/docsify.js

-1
This file was deleted.

Diff for: ‎docs/vendor/plugins/emoji-4.13.1.min.js

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎docs/vendor/plugins/emoji.min.js

-1
This file was deleted.

Diff for: ‎docs/vendor/plugins/search-4.13.1.min.js

+1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎docs/vendor/plugins/search.min.js

-1
This file was deleted.

0 commit comments

Comments
 (0)