|
|
@@ -1,4 +1,4 @@
|
|
|
-= Atom Editor Setup for Wiki Editing
|
|
|
+= Atom Editor for Wiki Editing
|
|
|
:author: mitm001
|
|
|
:revnumber:
|
|
|
:revdate: 2017-09-08T23:24:11.262Z
|
|
|
@@ -10,7 +10,7 @@ ifdef::env-github,env-browser[:outfilesuffix: .adoc]
|
|
|
|
|
|
Contributing to the Wiki is now easier than it ever has been. Using the Atom editor will give you an easy to use interface that is cross-platform, has code completion, syntax highlighting, instant AsciiDoctor page previewing, with an integrated GitHub client. The only thing it doesn't do is write the page for you.
|
|
|
|
|
|
-.Atom Editor Setup
|
|
|
+== Atom Editor Setup
|
|
|
. Download and install the Atom editor - https://atom.io/
|
|
|
. After installation is complete, you can customize the editor by selecting the `Choose A Theme` panel followed by the btn:[Theme Picker] button.
|
|
|
. Once you are satisfied with the customization of the editor, you will need to add several packages to make Atom AsciiDoctor compatible. Package installation is painless.
|
|
|
@@ -28,9 +28,11 @@ Contributing to the Wiki is now easier than it ever has been. Using the Atom edi
|
|
|
** Select btn:[GitHub: Clone].
|
|
|
** Paste `++https://github.com/jMonkeyEngine/wiki++` into the `Clone from` box. The `To directory` will automatically update when you do.
|
|
|
** When you're ready, press the btn:[Clone] button.
|
|
|
-
|
|
|
++
|
|
|
The clone will take some time due to the size of the Wiki. Once cloned, a new `Project` tab will open on the left, and the `Git` and `GitHub Preview` tabs will open to the right. If they don't, you can open the Git tab using kbd:[ctrl]+kbd:[shift]+kbd:[9] and the GitHub Preview tab using kbd:[ctrl]+kbd:[shift]+kbd:[8]. Alternatively, you can navigate the `menu:Packages[GitHub]` menu. You will also notice in the lower right corner, on the `Status Bar`, you now have your GitHub control.
|
|
|
|
|
|
+All Wiki documents live in the `asciidoc` folder, images in the `images` folder, and resources for your documents in the `resources` folder. Select an appropriate folder under each to store your new document, image or resource.
|
|
|
+
|
|
|
Before you can commit any changes to the Wiki, you must configure at least the user.email and user.name variables for Git. You can do this via Git Bash, or manually, by following these instructions.
|
|
|
|
|
|
* link:https://help.github.com/articles/setting-your-commit-email-address-in-git/[Setting your commit email address in Git]
|
|
|
@@ -42,9 +44,11 @@ Before you can commit any changes to the Wiki, you must configure at least the u
|
|
|
name = yourname
|
|
|
email = youremail
|
|
|
----
|
|
|
-
|
|
|
++
|
|
|
To maintain your privacy, setup your email settings in your GitHub account and use the `users.noreply.github.com` email address.
|
|
|
|
|
|
+Lastly, you will need to create a GitHub token. Follow the directions in the popup to enter the token.
|
|
|
+
|
|
|
When you edit a Wiki page, the Git tab will show any unstaged changes. When you're done making changes, you stage any or all changes, write your commit message, commit, and then push the changes.
|
|
|
|
|
|
You can add more GitHub controls to the editor by adding the package `*git-plus*`.
|
mitm001