@@ -1,83 +0,0 @@
1−# Urbit docs
2−
3−These are the urbit docs as they appear on [urbit.org](https://urbit.org/docs/).
4−
5−We've found it helps to have a clone of the docs on hand in case urbit.org
6−experiences high traffic. Follow these steps to get these into your ship:
7−
8−## Installation
9−
10−First, you'll need a running urbit. Follow our urbit.org [install
11−instructions](https://urbit.org/docs/getting-started/).
12−
13−### Local install
14−
15−In your urbit's Dojo:
16−
17− ~your-urbit:dojo> |mount /=home=
18−
19−You can now find your home desk at the path `/path/to/your-urbit/home/`.
20−
21−In Unix, clone this repo somewhere and copy in the `docs` files to your urbit's
22−mounted `%home` desk. You can run the following shell commands (*replacing your
23−urbit's home desk path as necessary*):
24−
25− $ git clone https://github.com/urbit/docs.git
26− $ cd ./docs/
27− $ cp -r ./docs* /path/to/your-urbit/home/web/
28−
29−Your Clay filesystem should acknowledge the newly added files.
30−
31−Lastly, make sure you're serving your home desk's `web` directory to the web by running the following Dojo command:
32−
33− ~your-urbit:dojo> |serve /=home=/web
34−
35−## Get started!
36−
37−And now your docs are live! View them at:
38−
39− http://localhost:8080/~~/docs
40−
41−> If you're running multiple ships locally, your port number will be `8081`,
42− `8082`, and so on. Check your Dojo output for the correct local port of
43− your examples urbit, or view these at `https://your-urbit.urbit.org` over DNS
44− instead for live-network ships. You can also replace `localhost` with the IP
45− of your instance, if you're running your urbit in the cloud.
46−
47−## Building the docs with |static
48−
49−**note** These instructions are for use with the the [static-site-dev branch](https://github.com/urbit/arvo/tree/static-site-dev)
50−of Arvo.
51−
52−Arvo comes with a built-in static site generator, which is very useful for
53−exporting sites and pages built with udon, sail, html, markdown or some
54−combination of these. Combinations like these docs that you're reading!
55−
56−In order to build the docs into a static site, do the following.
57−
58−Make sure that you've mounted your ship to your filesystem, but running the following
59−in your Dojo.
60−
61−> ~ship:dojo>|mount /===
62−
63−Then, copy these docs into the pier of a booted ship. It is very important that
64−copy the docs into the exact directory indicated in your pier.
65−
66−> $ cp -r . <ship-name>/home/web/static-site
67−
68−Now, run the static site generator on your urbit ship.
69−
70−> ~ship:dojo>|static
71−
72−You can now navigate to the output directory and run a webserver to view your built docs.
73−
74− $ cd <ship-name>/.urb/put/web/static-site
75− $ python -m SimpleHTTPServer
76−
77−Visit `localhost:8000` to see the built docs. Rerun `|static` to build docs and
78−see changes.
79−
80−## Contributing / Feedback
81−
82−Give us feedback on how we can make the docs better. Let us know about your ideas, requests, and/or problems and we'll
83−try and get back to you quickly. Issues and pull requests are more than welcome.