diff --git a/.gitignore b/.gitignore index 24ee6662..b4341aca 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,3 @@ .DS_Store -admin_guide/.DS_Store .vscode/settings.json output diff --git a/README.md b/README.md index 74c1fc39..e2183fa6 100644 --- a/README.md +++ b/README.md @@ -85,53 +85,57 @@ To do so, complete the following steps. 1. Ensure that Ruby is installed. -``` -ruby -v -``` + ```bash + ruby -v + ``` 1. If you haven't already installed pyenv and pyenv-virtualenv, go ahead and do so now. -``` -brew install pyenv -brew install pyenv-virtualenv -``` + ```bash + brew install pyenv + brew install pyenv-virtualenv + ``` 1. Initialize pyenv and virtualenv. -``` -eval "$(pyenv init -)" -eval "$(pyenv virtualenv-init -)" -``` + ```bash + eval "$(pyenv init -)" + eval "$(pyenv virtualenv-init -)" + ``` 1. Use pyenv to install Python 3.7.4. -``` -pyenv install 3.7.4 -``` + ```bash + pyenv install 3.7.4 + ``` -1. Install `ascii_binder` v0.1.15.1. +1. Install Asciidoctor. -``` -sudo gem install ascii_binder -v 0.1.15.1 -``` + ```bash + brew install asciidoctor + ```` -1. From the root of the repo, use the following command to install our custom `ascii_binder` package. +1. Install `ascii_binder` v0.1.15.1. -``` -sudo gem install -V ./ascii_binder_pan-0.0.00.1.gem -``` + ```bash + sudo gem install ascii_binder -v 0.1.15.1 + ``` -1. Run the `build_site.sh` script as follows +1. Navigate into the `_build` directory and use the following command to install our custom `ascii_binder` package. -``` -./build_site.sh ~/docs/ -``` - -1. Create a directory to store the generated files. + ```bash + sudo gem install -V ./ascii_binder_pan-0.0.00.1.gem + ``` -``` -open output/_package/main/index.html -``` +1. Return to the root directory and run the `build_site.sh` script as follows + ```bash + cd .. + ./build_site.sh + ``` +1. Open the generated site using the following command. + ```bash + open output/_package/main/index.html + ``` diff --git a/admin_guide/compliance/images/.DS_Store b/admin_guide/compliance/images/.DS_Store deleted file mode 100644 index 5008ddfc..00000000 Binary files a/admin_guide/compliance/images/.DS_Store and /dev/null differ diff --git a/admin_guide/continuous_integration/images/.DS_Store b/admin_guide/continuous_integration/images/.DS_Store deleted file mode 100644 index 5008ddfc..00000000 Binary files a/admin_guide/continuous_integration/images/.DS_Store and /dev/null differ diff --git a/admin_guide/firewalls/images/.DS_Store b/admin_guide/firewalls/images/.DS_Store deleted file mode 100644 index 5008ddfc..00000000 Binary files a/admin_guide/firewalls/images/.DS_Store and /dev/null differ diff --git a/admin_guide/howto/.DS_Store b/admin_guide/howto/.DS_Store deleted file mode 100644 index 7f6985a6..00000000 Binary files a/admin_guide/howto/.DS_Store and /dev/null differ diff --git a/admin_guide/install/.DS_Store b/admin_guide/install/.DS_Store deleted file mode 100644 index 168ee506..00000000 Binary files a/admin_guide/install/.DS_Store and /dev/null differ diff --git a/admin_guide/install/attachments/.DS_Store b/admin_guide/install/attachments/.DS_Store deleted file mode 100644 index 5008ddfc..00000000 Binary files a/admin_guide/install/attachments/.DS_Store and /dev/null differ diff --git a/admin_guide/install/images/.DS_Store b/admin_guide/install/images/.DS_Store deleted file mode 100644 index 5008ddfc..00000000 Binary files a/admin_guide/install/images/.DS_Store and /dev/null differ