infodocs 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +26 -0
- data/CONTRIBUTING.md +31 -0
- data/LICENSE.txt +21 -0
- data/README.md +341 -0
- data/Rakefile +10 -0
- data/app/controllers/infodocs/application_controller.rb +68 -0
- data/app/controllers/infodocs/assets_controller.rb +15 -0
- data/app/controllers/infodocs/editor_controller.rb +36 -0
- data/app/controllers/infodocs/indexes_controller.rb +22 -0
- data/app/controllers/infodocs/pages_controller.rb +48 -0
- data/app/controllers/infodocs/raws_controller.rb +13 -0
- data/app/controllers/infodocs/searches_controller.rb +18 -0
- data/app/controllers/infodocs/tags_controller.rb +11 -0
- data/app/controllers/infodocs/trees_controller.rb +40 -0
- data/app/helpers/infodocs/application_helper.rb +70 -0
- data/app/javascript/infodocs/application.js +74 -0
- data/app/javascript/infodocs/controllers/editor_controller.js +135 -0
- data/app/javascript/infodocs/controllers/highlight_controller.js +44 -0
- data/app/javascript/infodocs/controllers/mermaid_controller.js +25 -0
- data/app/javascript/infodocs/controllers/search_controller.js +125 -0
- data/app/javascript/infodocs/controllers/sidebar_controller.js +34 -0
- data/app/javascript/infodocs/controllers/toc_controller.js +18 -0
- data/app/javascript/infodocs/controllers/tree_editor_controller.js +65 -0
- data/app/javascript/infodocs/controllers/tree_state_controller.js +37 -0
- data/app/javascript/infodocs/vendor/sortable.esm.js +3378 -0
- data/app/views/infodocs/_delete_button.html.erb +6 -0
- data/app/views/infodocs/_handle.html.erb +5 -0
- data/app/views/infodocs/_tree.html.erb +35 -0
- data/app/views/infodocs/editor/edit.html.erb +61 -0
- data/app/views/infodocs/pages/empty_folder.html.erb +6 -0
- data/app/views/infodocs/pages/not_found.html.erb +11 -0
- data/app/views/infodocs/pages/show.html.erb +92 -0
- data/app/views/infodocs/searches/index.html.erb +20 -0
- data/app/views/infodocs/tags/index.html.erb +26 -0
- data/app/views/layouts/infodocs/application.html.erb +104 -0
- data/config/importmap.rb +6 -0
- data/config/routes.rb +26 -0
- data/lib/generators/infodocs/install/install_generator.rb +59 -0
- data/lib/generators/infodocs/install/templates/getting-started.md.tt +8 -0
- data/lib/generators/infodocs/install/templates/initializer.rb.tt +51 -0
- data/lib/generators/infodocs/views/views_generator.rb +13 -0
- data/lib/infodocs/code_theme.rb +130 -0
- data/lib/infodocs/configuration.rb +50 -0
- data/lib/infodocs/engine.rb +39 -0
- data/lib/infodocs/link_checker.rb +43 -0
- data/lib/infodocs/linter.rb +48 -0
- data/lib/infodocs/page.rb +124 -0
- data/lib/infodocs/rails_lexer.rb +39 -0
- data/lib/infodocs/renderer.rb +231 -0
- data/lib/infodocs/search.rb +131 -0
- data/lib/infodocs/source.rb +35 -0
- data/lib/infodocs/tree.rb +215 -0
- data/lib/infodocs/tree_editor.rb +179 -0
- data/lib/infodocs/url_helper.rb +23 -0
- data/lib/infodocs/version.rb +5 -0
- data/lib/infodocs.rb +74 -0
- data/lib/tasks/infodocs.rake +63 -0
- data/sig/infodocs.rbs +4 -0
- metadata +192 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { Controller } from "@hotwired/stimulus"
|
|
2
|
+
|
|
3
|
+
const KEY = "infodocs:open-folders"
|
|
4
|
+
|
|
5
|
+
// Remembers which sidebar folders are open and scrolls the sidebar to the
|
|
6
|
+
// current page.
|
|
7
|
+
export default class extends Controller {
|
|
8
|
+
connect() {
|
|
9
|
+
const saved = this.#read()
|
|
10
|
+
this.element.querySelectorAll("li[data-slug] > details").forEach((details) => {
|
|
11
|
+
if (saved.includes(details.parentElement.dataset.slug)) details.open = true
|
|
12
|
+
})
|
|
13
|
+
this.onToggle = () => this.#write()
|
|
14
|
+
this.element.addEventListener("toggle", this.onToggle, true)
|
|
15
|
+
requestAnimationFrame(() => this.#scrollToCurrent())
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
disconnect() { this.element.removeEventListener("toggle", this.onToggle, true) }
|
|
19
|
+
|
|
20
|
+
#scrollToCurrent() {
|
|
21
|
+
const link = this.element.querySelector("a[aria-current=page]")
|
|
22
|
+
const panel = this.element.closest("aside")
|
|
23
|
+
if (!link || !panel) return
|
|
24
|
+
|
|
25
|
+
const offset = link.getBoundingClientRect().top - panel.getBoundingClientRect().top
|
|
26
|
+
panel.scrollTop += offset - panel.clientHeight / 2
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
#read() {
|
|
30
|
+
try { return JSON.parse(localStorage.getItem(KEY)) || [] } catch { return [] }
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
#write() {
|
|
34
|
+
const open = [...this.element.querySelectorAll("li[data-slug] > details[open]")].map((details) => details.parentElement.dataset.slug)
|
|
35
|
+
try { localStorage.setItem(KEY, JSON.stringify(open)) } catch { /* storage unavailable */ }
|
|
36
|
+
}
|
|
37
|
+
}
|