archwiki-rs: add page (#12700)

pull/28/head
June Gschwantner 2024-05-02 04:20:32 +00:00 committed by GitHub
parent 2f1108cf76
commit 0b811667ba
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 0 deletions

View File

@ -0,0 +1,20 @@
# archwiki-rs
> Read, search and download pages from the ArchWiki.
> More information: <https://gitlab.com/lucifayr/archwiki-rs>.
- Read a page from the ArchWiki:
`archwiki-rs read-page {{page_title}}`
- Read a page from the ArchWiki in the specified format:
`archwiki-rs read-page {{page_title}} --format {{plain-text|markdown|html}}`
- Search the ArchWiki for pages containing the provided text:
`archwiki-rs search "{{search_text}}" --text-search`
- Download a local copy of all ArchWiki pages into a specific directory:
`archwiki-rs local-wiki {{/path/to/local_wiki}} --format {{plain-text|markdown|html}}`