Merge pull request #1158 from 0xProject/docSectionFixes

Update Doc Ref Markdown Sections

3 files changed, 55 insertions, 0 deletions

diff --git a/packages/website/md/docs/sol-compiler/1/installation.md b/packages/website/md/docs/sol-compiler/1/installation.md
new file mode 100644
index 000000000..9c8561d9b
--- /dev/null
+++ b/packages/website/md/docs/sol-compiler/1/installation.md
@@ -0,0 +1,23 @@
+#### CLI Installation
+
+```bash
+yarn global add @0xproject/sol-compiler
+```
+
+#### API Installation
+
+```bash
+yarn add @0xproject/sol-compiler
+```
+
+**Import**
+
+```typescript
+import { Compiler } from '@0xproject/sol-compiler';
+```
+
+or
+
+```javascript
+var Compiler = require('@0xproject/sol-compiler').Compiler;
+```
diff --git a/packages/website/md/docs/sol-compiler/1/introduction.md b/packages/website/md/docs/sol-compiler/1/introduction.md
new file mode 100644
index 000000000..fcd80f47b
--- /dev/null
+++ b/packages/website/md/docs/sol-compiler/1/introduction.md
@@ -0,0 +1,8 @@
+Welcome to the [sol-compiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-compiler) documentation! Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) that adds:
+
+*   Smart re-compilation: Only recompiles when smart contracts have changed
+*   Ability to compile an entire project instead of only individual `.sol` files
+*   Compilation using the Solidity version specified at the top of each individual `.sol` file
+*   Proper parsing of Solidity version ranges
+*   Support for the standard [input description](https://solidity.readthedocs.io/en/develop/using-the-compiler.html#input-description) for what information you'd like added to the resulting `artifacts` file (i.e 100% configurable artifacts content).
+*   Storage of constructor args, source maps and paths to all dependency source files.
diff --git a/packages/website/md/docs/sol-compiler/1/usage.md b/packages/website/md/docs/sol-compiler/1/usage.md
new file mode 100644
index 000000000..79c9b32ba
--- /dev/null
+++ b/packages/website/md/docs/sol-compiler/1/usage.md
@@ -0,0 +1,24 @@
+#### CLI Usage
+
+```bash
+$ sol-compiler
+Options:
+  --version        Show version number                                 [boolean]
+  --contracts-dir  path of contracts directory to compile               [string]
+  --artifacts-dir  path to write contracts artifacts to                 [string]
+  --contracts      comma separated list of contracts to compile
+                                                         [string] [default: "*"]
+  --help           Show help                                           [boolean]
+```
+
+#### API Usage
+
+```typescript
+import { Compiler } from '@0xproject/sol-compiler';
+
+const compiler = new Compiler();
+
+(async () => {
+    await compiler.compileAllAsync();
+})().catch(console.log);
+```