mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-04-05 10:59:33 +00:00
Update documentation
This commit is contained in:
parent
ffa6cc580b
commit
e7a0f92a3a
@ -22,6 +22,7 @@ highlight_themes_css = [
|
|||||||
[link_checker]
|
[link_checker]
|
||||||
skip_prefixes = [
|
skip_prefixes = [
|
||||||
"http://localhost",
|
"http://localhost",
|
||||||
|
"https://docs.github.com", # doesn't allow checking anymore
|
||||||
"/openapi",
|
"/openapi",
|
||||||
"https://www.abisource.com" # has bad ssl config
|
"https://www.abisource.com" # has bad ssl config
|
||||||
]
|
]
|
||||||
|
@ -167,9 +167,8 @@ export QEMU_NET_OPTS "hostfwd=tcp::7880-:7880"
|
|||||||
|
|
||||||
# Release
|
# Release
|
||||||
|
|
||||||
The CI and making a release is done via [github
|
The CI and making a release is done via github actions. The workflow
|
||||||
actions](https://docs.github.com/en/actions). The workflow is roughly
|
is roughly like this:
|
||||||
like this:
|
|
||||||
|
|
||||||
- each PR is only merged if the `sbt ci` task returns successfully.
|
- each PR is only merged if the `sbt ci` task returns successfully.
|
||||||
This is ensured by the `ci.yml` workflow that triggers on each pull
|
This is ensured by the `ci.yml` workflow that triggers on each pull
|
||||||
|
@ -360,7 +360,7 @@ You can publish your work to this repo in various ways:
|
|||||||
This is the preferred way, because it means less work for me :). If
|
This is the preferred way, because it means less work for me :). If
|
||||||
you have a github account, you can create a pull request. Here is a
|
you have a github account, you can create a pull request. Here is a
|
||||||
quick walk-through. There is a thorough help [at
|
quick walk-through. There is a thorough help [at
|
||||||
github](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests).
|
github](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
|
||||||
|
|
||||||
1. Fork this repository in the github webapp
|
1. Fork this repository in the github webapp
|
||||||
2. Go to the docspell source root you checked out in the terminal. Run:
|
2. Go to the docspell source root you checked out in the terminal. Run:
|
||||||
|
@ -41,10 +41,14 @@ must be extracted and installed manually somewhere in your `$PATH`.
|
|||||||
|
|
||||||
## Using deb files
|
## Using deb files
|
||||||
|
|
||||||
|
Please checkout this comprehensive
|
||||||
|
[guide](https://github.com/andreklug/docspell-debian) for installing
|
||||||
|
on a Debian system.
|
||||||
|
|
||||||
Packages are also provided at the release page:
|
Packages are also provided at the release page:
|
||||||
|
|
||||||
- [docspell-restserver_{{version()}}_all.deb](https://github.com/eikek/docspell/releases/download/v{{version()}}/docspell-restserver_{{version()}}_all.deb)
|
- <a href="https://github.com/eikek/docspell/releases/download/v{{version()}}/docspell-restserver_{{version()}}_all.deb">docspell-restserver_{{version()}}_all.deb</a>
|
||||||
- [docspell-joex_{{version()}}_all.deb](https://github.com/eikek/docspell/releases/download/v{{version()}}/docspell-joex_{{version()}}_all.deb)
|
- <a href="https://github.com/eikek/docspell/releases/download/v{{version()}}/docspell-joex_{{version()}}_all.deb">docspell-joex_{{version()}}_all.deb</a>
|
||||||
|
|
||||||
The DEB packages can be installed on Debian, or Debian based Distros:
|
The DEB packages can be installed on Debian, or Debian based Distros:
|
||||||
|
|
||||||
@ -58,10 +62,6 @@ or `docspell-joex` from a terminal window.
|
|||||||
The packages come with a systemd unit file that will be installed to
|
The packages come with a systemd unit file that will be installed to
|
||||||
autostart the services.
|
autostart the services.
|
||||||
|
|
||||||
The provided scripts in `docspell-tools-{{version()}}.zip` must be
|
|
||||||
extracted and installed manually somewhere in your `$PATH`. There are
|
|
||||||
no deb files provided.
|
|
||||||
|
|
||||||
|
|
||||||
# Running
|
# Running
|
||||||
|
|
||||||
|
@ -12,9 +12,6 @@ The **d**oc**s**pell **c**lient, short
|
|||||||
docspell through the command line. It is also aims to be useful for
|
docspell through the command line. It is also aims to be useful for
|
||||||
your own scripts and programs.
|
your own scripts and programs.
|
||||||
|
|
||||||
It is supposed to replace most of the shell scripts from the `tools/`
|
|
||||||
directory.
|
|
||||||
|
|
||||||
It is a work in progress; eventually most of the
|
It is a work in progress; eventually most of the
|
||||||
[api](@/docs/api/_index.md) will be covered.
|
[api](@/docs/api/_index.md) will be covered.
|
||||||
|
|
||||||
|
BIN
website/site/content/docs/tools/ds4e-01.png
Normal file
BIN
website/site/content/docs/tools/ds4e-01.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 376 KiB |
BIN
website/site/content/docs/tools/ds4e-01_light.png
Normal file
BIN
website/site/content/docs/tools/ds4e-01_light.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 370 KiB |
27
website/site/content/docs/tools/ds4e.md
Normal file
27
website/site/content/docs/tools/ds4e.md
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
+++
|
||||||
|
title = "Emacs"
|
||||||
|
description = "Docspell from Emacs."
|
||||||
|
weight = 30
|
||||||
|
+++
|
||||||
|
|
||||||
|
# Ds4e
|
||||||
|
|
||||||
|
If you use Emacs you might find the
|
||||||
|
[ds4e](https://github.com/docspell/ds4e) project useful. It provides a
|
||||||
|
few packages to use Docspell from within Emacs.
|
||||||
|
|
||||||
|
It is implemented as a wrapper to the [cli](@/docs/tools/cli.md) tool,
|
||||||
|
which must be installed first.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
The ds4e is a collection of Emacs packages that provide mainly
|
||||||
|
integrations into other Emacs packages, like mu4e, dired or dashboard.
|
||||||
|
|
||||||
|
The `ds4e-search` package allows to search and view documents.
|
||||||
|
|
||||||
|
Please refer to the [README](https://github.com/docspell/ds4e) for
|
||||||
|
details.
|
||||||
|
|
||||||
|
|
||||||
|
{{ figure2(light="ds4e-01_light.png", dark="ds4e-01.png") }}
|
Loading…
x
Reference in New Issue
Block a user