git.iko.soy/urbit.org
on 22ebade help sign in
urbit.org/readme.md
83 lines 2.9 kB history raw
1# Urbit docs
3These are the urbit docs as they appear on [urbit.org](https://urbit.org/docs/).
5We've found it helps to have a clone of the docs on hand in case urbit.org
6experiences high traffic. Follow these steps to get these into your ship:
8## Installation
10First, you'll need a running urbit. Follow our urbit.org [install
11instructions](https://urbit.org/docs/getting-started/).
13### Local install
15In your urbit's Dojo:
17 ~your-urbit:dojo> |mount /=home=
19You can now find your home desk at the path `/path/to/your-urbit/home/`.
21In Unix, clone this repo somewhere and copy in the `docs` files to your urbit's
22mounted `%home` desk. You can run the following shell commands (*replacing your
23urbit's home desk path as necessary*):
25 $ git clone https://github.com/urbit/docs.git
26 $ cd ./docs/
27 $ cp -r ./docs* /path/to/your-urbit/home/web/
29Your Clay filesystem should acknowledge the newly added files.
31Lastly, make sure you're serving your home desk's `web` directory to the web by running the following Dojo command:
33 ~your-urbit:dojo> |serve /=home=/web
35## Get started!
37And now your docs are live! View them at:
39 http://localhost:8080/~~/docs
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.
47## Building the docs with |static
49**note** This instructions are for use with the the [release-candidate branch](https://github.com/urbit/arvo/tree/release-candidate)
50of Arvo.
52Arvo comes with a built-in static site generator, which is very useful for
53exporting sites and pages built with udon, sail, html, markdown or some
54combination of these. Combinations like these docs that you're reading!
56In order to build the docs into a static site, do the following.
58Make sure that you've mounted your ship to your filesystem, but running the following
59in your Dojo.
61> ~ship:dojo>|mount /===
63Then, copy these docs into the pier of a booted ship. It is very important that
64copy the docs into the exact directory indicated in your pier.
66> $ cp -r . <ship-name>/home/web/static-site
68Now, run the static site generator on your urbit ship.
70> ~ship:dojo>|static
72You can now navigate to the output director and run a webserver to view your built docs.
74> $ cd <ship-name>/.urb/put/web/static-site
75> $ python -m SimpleHTTPServer
77Visit `localhost:8000` to see the built docs. Rerun `|static` to build docs and
78see changes.
80## Contributing / Feedback
82Give us feedback on how we can make the docs better. Let us know about your ideas, requests, and/or problems and we'll
83try and get back to you quickly. Issues and pull requests are more than welcome.