Restore docs in private folder
This commit is contained in:
parent
5b9612f57e
commit
85e6234708
|
@ -68,11 +68,11 @@ workspace
|
||||||
/doc/COMMUNITY.org
|
/doc/COMMUNITY.org
|
||||||
/doc/CONTRIBUTING.org
|
/doc/CONTRIBUTING.org
|
||||||
/games/
|
/games/
|
||||||
private/
|
# private/
|
||||||
!private/README.md
|
# !private/README.md
|
||||||
!private/snippets/README.md
|
# !private/snippets/README.md
|
||||||
!private/templates/README.md
|
# !private/templates/README.md
|
||||||
!private/local/README.md
|
# !private/local/README.md
|
||||||
|
|
||||||
# Ignore tags created by cscope, etags, ctags, and gtags (GNU global)
|
# Ignore tags created by cscope, etags, ctags, and gtags (GNU global)
|
||||||
# source: https://github.com/github/gitignore/blob/master/Global/Tags.gitignore
|
# source: https://github.com/github/gitignore/blob/master/Global/Tags.gitignore
|
||||||
|
|
|
@ -0,0 +1,21 @@
|
||||||
|
# Private directory
|
||||||
|
|
||||||
|
The content of this directory is ignored by Git. This is the default place
|
||||||
|
where to store your private configuration layers.
|
||||||
|
|
||||||
|
To create a new configuration layer:
|
||||||
|
|
||||||
|
SPC SPC configuration-layer/create-layer RET
|
||||||
|
|
||||||
|
Then enter the name of your configuration in the prompt.
|
||||||
|
|
||||||
|
A directory named after the created configuration layer will be created here
|
||||||
|
along with template files within it (packages.el and extensions.el, more info
|
||||||
|
on the meaning of those files can be found in the [documentation][conf_layers]).
|
||||||
|
|
||||||
|
Each created file has further guidance written in them.
|
||||||
|
|
||||||
|
Once the configuration is done, restart Emacs to load, install and configure
|
||||||
|
your layer.
|
||||||
|
|
||||||
|
[conf_layers]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.org#extensions-and-packages
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Private directory for local packages
|
||||||
|
|
||||||
|
The content of this directory is ignored by Git.
|
||||||
|
|
||||||
|
This is the place to store the local packages that you define in the
|
||||||
|
`dotspacemacs-additional-packages` variable of your dotfile.
|
||||||
|
|
||||||
|
Additional packages can be added using the same recipe as for [adding packages
|
||||||
|
to layers](https://develop.spacemacs.org/doc/LAYERS.html#packagesel) i.e.:
|
||||||
|
|
||||||
|
- For a local package:
|
||||||
|
- Load the file explicitly, using the full path to the file, by placing a
|
||||||
|
`(load "~/.emacs.d/private/local/package-name")` within the body of the
|
||||||
|
`dotspacemacs/user-config` function of your dotspacemacs file.
|
||||||
|
- Alternatively create a directory with the name of the package in the
|
||||||
|
`.emacs.d/private/local` directory, and add that directory to the load-path
|
||||||
|
variable by adding `(some-package :location local)` to the list
|
||||||
|
`dotspacemacs-additional-packages` within the `dotspacemacs/layers` function
|
||||||
|
of your dotspacemacs file. After placing your package file into this
|
||||||
|
package-directory the file can be loaded, without requiring the full path, by
|
||||||
|
placing a `(require 'package-name)` within the body of the
|
||||||
|
`dotspacemacs/user-config` function of your dotspacemacs file.
|
||||||
|
|
||||||
|
- If the package is on (M)ELPA simply add the package name to the list
|
||||||
|
`dotspacemacs-additional-packages` in your dotspacemacs file
|
||||||
|
|
||||||
|
- For a package hosted on github the recipe for github packages can be used i.e. add
|
||||||
|
|
||||||
|
```
|
||||||
|
(some-package :location (recipe
|
||||||
|
:fetcher github
|
||||||
|
:repo "some/repo"))
|
||||||
|
```
|
||||||
|
|
||||||
|
to the list `dotspacemacs-additional-packages` in your dotspacemacs file.
|
|
@ -0,0 +1,6 @@
|
||||||
|
# Private directory for Yasnippets snippets
|
||||||
|
|
||||||
|
The content of this directory is ignored by Git. This is the default place
|
||||||
|
where to store your private yasnippets.
|
||||||
|
|
||||||
|
This path will be loaded automatically and used whenever Yasnippets loads.
|
|
@ -0,0 +1,6 @@
|
||||||
|
# Private directory for Yatemplate templates
|
||||||
|
|
||||||
|
The content of this directory is ignored by Git. This is the default place
|
||||||
|
where to store your private templates.
|
||||||
|
|
||||||
|
This path will be loaded automatically and used whenever Yatemplate loads.
|
Loading…
Reference in New Issue