https://github.com/jaremko/spacetools

Spacemacs age tool box
https://github.com/jaremko/spacetools

docker documentation-tool emacs graal-native org-mode spacemacs

Last synced: over 1 year ago
JSON representation

Spacemacs age tool box

• Host: GitHub
• URL: https://github.com/jaremko/spacetools
• Owner: JAremko
• License: epl-2.0
• Created: 2018-02-19T13:44:52.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-05-30T07:14:54.000Z (about 3 years ago)
• Last Synced: 2025-04-13T22:14:33.356Z (over 1 year ago)
• Topics: docker, documentation-tool, emacs, graal-native, org-mode, spacemacs
• Language: Clojure
• Homepage:
• Size: 1.34 MB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/JAremko/spacetools.svg?branch=master)](https://travis-ci.org/JAremko/spacetools)

[![codecov.io](https://codecov.io/github/JAremko/spacetools/coverage.svg?branch=master)](https://codecov.io/github/JAremko/spacetools?branch=master)

### Spacemacs tools

*Available at DockerHub as `jare/spacetools:latest`, `jare/spacetools:noemacs`*

```sh

Spacemacs tools

usage: run ACTION [ARGS]...

Actions:

  validoc ROOT [INPUTS]... Validate Spacemacs documentation files.

                           If only the first argument is supplied

                           the default list of documentation files

                           will be used.

  docfmt  ROOT [INPUTS]... Format Spacemacs documentation files.

                           If only the first argument is supplied

                           the default list of documentation files

                           will be used.

Common arguments:

  ROOT   root directory of Spacemacs documentation. Example: "~/.emacs.d/".

  INPUTS are processed .org files or directories containing them.

```

**Usage example:**

Format all files (add `--user :` to keep ownership):

`docker run --rm -v :/tmp/docs/ jare/spacetools docfmt /tmp/docs/`

Validate:

`docker run --rm -v :/tmp/docs/ jare/spacetools validoc /tmp/docs/`

To run with custom configuration file add:

`-v :/opt/spacetools/spacedoc-cfg.edn`

Spacemacs uses [this config file](https://raw.githubusercontent.com/syl20bnr/spacemacs/develop/.ci/spacedoc-cfg.edn)