or
or
By clicking below, you agree to our terms of service.
New to HackMD? Sign up
Syntax | Example | Reference | |
---|---|---|---|
# Header | Header | 基本排版 | |
- Unordered List |
|
||
1. Ordered List |
|
||
- [ ] Todo List |
|
||
> Blockquote | Blockquote |
||
**Bold font** | Bold font | ||
*Italics font* | Italics font | ||
~~Strikethrough~~ | |||
19^th^ | 19th | ||
H~2~O | H2O | ||
++Inserted text++ | Inserted text | ||
==Marked text== | Marked text | ||
[link text](https:// "title") | Link | ||
 | Image | ||
`Code` | Code |
在筆記中貼入程式碼 | |
```javascript var i = 0; ``` |
|
||
:smile: | ![]() |
Emoji list | |
{%youtube youtube_id %} | Externals | ||
$L^aT_eX$ | LaTeX | ||
:::info This is a alert area. ::: |
This is a alert area. |
On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?
Please give us some advice and help us improve HackMD.
Syncing
xxxxxxxxxx
Environment Setup Guide
Ensure Github Access
Ensure personal account access
Ensure IT has added to proper teams
Ensure SSH keypair on file
Setup Mac Dev Environment
Ensure Node is installed
Install node/js 8.1.2
brew install node@8.1.2
NB: for devs, make sure you can switch down to an older node via
nvm
or other managernvm use 8.1.2
Trouble with NPM?
Try installing just regular node.
brew install node
Ensure a code editor is installed
we recommend downloading VSCode
Install colored git branches
Add this snippet to your .bash_profile
vim ~/.bash_profile
Paste in these lines:
Save and quit.
Run
source ~/.bash_profile
to reload the changes into any open terminals. It will automatically load itself into new windows after that.(Optional) Install bash autocompletion
Link to Git Tips and Tricks to understand using Autocomplete
source ~/git-completion.bash
, it will now read in every time you open your terminal(Optional) Export shell path for code
This allows you to open code directly from the command line
From within VSCode editor, open to any file or none
cmd + t
to open the command shortcut bartype in
> shell
to pull up the quick command to add the code command to the path(Optional) Install VSCode extensions
Extensions can make it easier to work within the editor. Open the extensions browser by clicking the Settings Icon in the very lower left of VSCode and choosing
Extensions
, or, as you can see, it has a shortcut.One extension that is often useful is
Gitlens
.Clone the Repo You Need
Ensure working directory
As the products grow, so do the places where documentation lives. Tech writers will end up with more than a few repos that you will work in and contribute to as part of your work.
mkdir d2iq
CD into your working directory
cd d2iq
Clone the repo you need
We will be using the docs site repo for all examples, but this might also be another product repo within D2iQ.
git clone dcos-docs-site
NB: On first time setup, you may need to follow the instructions to install xcode tools to get git functionality
cd
into the Repo you just clonedcd dcos-docs-site
Open the repo in your code editor
If you installed the shell extension, you can now open the folder your terminal is in with the command:
code .
Initialize the Repo (Docs Repo Only)
Content that is kept on other team repos would follow their init, if applicable.
Install node modules
This must be only done on first time or if a rare site tooling change occurs. Other repos may have other needs, see their Contributing Guide or similar resource for assistance if you will need to build their code.
npm install
Build the API page sets
This is necessary anytime a set is changed, or when a new DC/OS version (and there for a new set) is created
make build-api
This takes about 8 mins. It builds the folders
build-ngindox
andbiuld-swagger
.Build a local preview
This is to ensure setup was successful
npm run dev
Open a browser and navigate to
localhost:3000
to view the documentation site on your local systemProblems?
Running a build on first install is to ensure that all tools have been installed and are reading the code correctly. Please make sure to debug any errors at this point until you can get a full preview of the docs site at localhost:3000 in your browser.
:TODO: image localhost docs landing page
Stop the local preview server
This necessary once you are done previewing, not great to leave it running.
ctrl-c