██████╗ ██████╗ █████╗ ██████╗████████╗██╗ ██████╗ █████╗ ██╗ ██╗ ██╗
██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝██║██╔════╝██╔══██╗██║ ██║ ██║
██████╔╝██████╔╝███████║██║ ██║ ██║██║ ███████║██║ ██║ ██║
██╔═══╝ ██╔══██╗██╔══██║██║ ██║ ██║██║ ██╔══██║██║ ██║ ██║
██║ ██║ ██║██║ ██║╚██████╗ ██║ ██║╚██████╗██║ ██║███████╗███████╗██║
╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚══════╝╚═╝
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.
Create a free Clojurians Slack community account.
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
This is not a guide to customising Emacs for Clojure development, except were there are useful additions to be made to Spacemacs and the Clojure layer.
This work is licensed under a Creative Commons Attribution 4.0 ShareAlike License (including images & stylesheets).
Please read the contributing section of the book before raising an issue or pull request
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. Attribution will be detailed via GitHub contributors.
The majority of my work is focused on the Practicalli series of books and videos and an advisory role with several communities
Thank you to Cognitect, Nubank and a wide range of other sponsors for your continued support
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
Install mkdocs version 9 using the Python pip package manager
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)
pip3 install mkdocs-material mkdocs-callouts mkdocs-glightbox mkdocs-git-revision-date-localized-plugin mkdocs-redirects pillow cairosvgpillow and cairosvg python packages are required for Social Cards
Fork the GitHub repository and clone that fork to your computer,
git clone https://github.com/<your-github-account>/<repository>.gitRun a local server from the root of the cloned project
make docsThe website will open at http://localhost:8000
If making smaller changes, then only rebuild the content that changes, speeding up the local development process
make docs