https://github.com/practicalli/spacemacs
Content for the book - Clojure Development with Spacemacs
https://github.com/practicalli/spacemacs
cider clojure emacs spacemacs
Last synced: 2 months ago
JSON representation
Content for the book - Clojure Development with Spacemacs
- Host: GitHub
- URL: https://github.com/practicalli/spacemacs
- Owner: practicalli
- License: cc-by-sa-4.0
- Created: 2016-04-27T23:14:21.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-01-21T22:05:03.000Z (over 1 year ago)
- Last Synced: 2024-04-10T10:18:46.403Z (about 1 year ago)
- Topics: cider, clojure, emacs, spacemacs
- Language: HTML
- Homepage: https://practical.li/spacemacs
- Size: 133 MB
- Stars: 107
- Watchers: 7
- Forks: 33
- Open Issues: 231
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
```none
██████╗ ██████╗ █████╗ ██████╗████████╗██╗ ██████╗ █████╗ ██╗ ██╗ ██╗
██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝██║██╔════╝██╔══██╗██║ ██║ ██║
██████╔╝██████╔╝███████║██║ ██║ ██║██║ ███████║██║ ██║ ██║
██╔═══╝ ██╔══██╗██╔══██║██║ ██║ ██║██║ ██╔══██║██║ ██║ ██║
██║ ██║ ██║██║ ██║╚██████╗ ██║ ██║╚██████╗██║ ██║███████╗███████╗██║
╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚══════╝╚═╝
```
# Clojure development with Spacemacs
This is an introduction to developing Clojure applications using Emacs, specifically based on the Spacemacs configuration for Emacs and CIDER. The aim is to help you be productive with those tools as quickly as possible.
Spacemacs is a community-driven project that provides a simple way to add lots of extra functionality to Emacs, without having to manage packages yourself or spend time writing common configuration code.
[Discuss this guide on #practicalli channel of the Clojurians Slack community](https://clojurians.slack.com/messages/practicalli).
[Create a free Clojurians Slack community account](http://clojurians.net/).
This workshop will cover the following topics:
* Emacs basics, common commands and tools
* Powerful editing and refactor tools (iedit, narrowing, helm-ag, multiple cursors, visual undo)
* Adding and enhancing the Clojure layer
* Running the REPL, evaluating code, inspecting data, debug, reloaded workflow
* Running tests & test reports
* Structural editing (smartparens/evil-cleverparens)
* Clojure docs, auto-completion, snippets
* Clojurescript development, figwheel-main and reagent
* Org-mode for project documentation, literate programming & presentations
## Book status
[](https://img.shields.io/github/issues/practicalli/spacemacs?label=content%20ideas&logo=github)
[](https://img.shields.io/github/commit-activity/y/practicalli/spacemacs?label=commits&logo=github)
[](https://img.shields.io/github/issues-pr-raw/practicalli/spacemacs?label=pull%20requests&logo=github)
[](https://github.com/practicalli/spacemacs/actions/workflows/megalinter.yaml)
[](https://github.com/practicalli/spacemacs/actions/workflows/publish-book.yaml)
[](https://github.com/practicalli/spacemacs/actions/workflows/pages/pages-build-deployment)
## Creative commons license
This work is licensed under a Creative Commons Attribution 4.0 ShareAlike License (including images & stylesheets).
## Contributing
Please [read the contributing section of the book](https://practical.li/spacemacs/introduction/contributing/) before raising an issue or pull request
* [Current Issues](https://github.com/practicalli/spacemacs/issues)
* [Current pull requests](https://github.com/practicalli/spacemacs/pulls)
By submitting content ideas and corrections you are agreeing they can be used in this workshop under the [Creative Commons Attribution ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/). Attribution will be detailed via [GitHub contributors](https://github.com/practicalli/neovim/graphs/contributors).
## Sponsor Practicalli
[](https://github.com/sponsors/practicalli-johnny/)
All sponsorship funds are used to support the continued development of [Practicalli series of books and videos](https://practical.li/), although most of the work is still done at personal cost and time.
Thanks to [Cognitect](https://www.cognitect.com/), [Nubank](https://nubank.com.br/) and a wide range of other [sponsors](https://github.com/sponsors/practicalli-johnny#sponsors) for your continued support
## GitHub Actions
The megalinter GitHub actions will run when a pull request is created,checking basic markdown syntax.
A review of the change will be carried out by the Practicalli team and the PR merged if the change is acceptable.
The Publish Book GitHub action will run when PR's are merged into main (or the Practicalli team pushes changes to the default branch).
Publish book workflow installs Material for MkDocs version 9
## Local development
Install mkdocs version 9 using the Python pip package manager
```bash
pip3 install mkdocs-material=="9.4"
```
Install the plugins used by the Practicalli site using Pip (these are also installed in the GitHub Action workflow)
```bash
pip3 install mkdocs-material mkdocs-callouts mkdocs-glightbox mkdocs-git-revision-date-localized-plugin mkdocs-redirects pillow cairosvg
```
> pillow and cairosvg python packages are required for [Social Cards](https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/)
Fork the GitHub repository and clone that fork to your computer,
```bash
git clone https://github.com//.git
```
Run a local server from the root of the cloned project
```bash
make docs
```
The website will open at
If making smaller changes, then only rebuild the content that changes, speeding up the local development process
```bash
make docs
```