Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akhenakh/docindex
An indexer for mkdocs documentation
https://github.com/akhenakh/docindex
Last synced: 24 days ago
JSON representation
An indexer for mkdocs documentation
- Host: GitHub
- URL: https://github.com/akhenakh/docindex
- Owner: akhenakh
- Created: 2020-10-13T12:50:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-24T22:56:31.000Z (over 1 year ago)
- Last Synced: 2024-06-21T15:48:02.753Z (5 months ago)
- Language: Go
- Size: 24.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docindex
An indexer for mkdocs documentation, it uses [Bleve](https://github.com/blevesearch/bleve), so [complex queries](http://blevesearch.com/docs/Query-String-Query/) can be used.
First index your data
```
Usage of ./index:
-docPath string
mkdocs config path (default "mkdocs.yml")
-indexPath string
index db path (default "index.db")
```
Then use the query tool
```
Usage of ./query:
-indexPath string
index db path (default "index.db")
-limit int
limit response count (default 10)
-lucky
I feel lucky, open the first found result
-q string
query string
```
## Example:
```
./index -docPath ../my-docs/mkdocs.yml
2020/10/13 09:04:32 main.go:145: Indexing: [index.md] Home Home [Home,Home]
2020/10/13 09:04:32 main.go:145: Indexing: [office-hours.md] Office Hours [Home,Office Hours]
2020/10/13 09:04:32 main.go:145: Indexing: [contributing/contributing.md] Contributing [Home,Contributing,MkDocs]
2020/10/13 09:04:32 main.go:145: Indexing: [contributing/tips.md] Tips and Tricks [Home,Contributing,Tips and Tricks]
...
./query -q "drone -gcp"
63 matches, showing 1 through 10, took 11.469714ms
1. drone/v1/cli.md (0.972849)
Title
Tools & Platforms CI/CD Drone CLI
Tags
Tools & Platforms CI/CD Drone CLI
Body
… If you used the Drone v0.8 CLI tool, you'll need to update to the latest version and configuration for it to work properly with Drone v1. Install the latest version of the CLI version using the follo…
2. drone/v1/run_jobs_manually.md (0.715997)
Tags
Tools & Platforms CI/CD Drone Run Jobs Manually
Body
… webhooks, you can run Drone jobs on your computer's Docker daemon.
We still recommend using the server during your day-to-day development process. !!! info
Ensure the Drone CLI is , as well as D…
3. drone/README.md (0.690244)
Tags
Tools & Platforms CI/CD Drone Overview
Body
Drone is an built on container technologies.
....
```
## TODO web frontend for mkdocs