git.iko.soy/urbit.org
on 2d648ca help sign in
urbit.org/readme.md
94 lines 3.3 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/using/install/), then
12[setup](https://urbit.org/docs/using/setup/) an urbit.
14### Local install
16In your urbit's Dojo:
18 ~your-urbit:dojo> |mount /=home=
20You can now find your home desk at the path `/path/to/your-urbit/home/`.
22In Unix, clone this repo somewhere and copy in the `docs` files to your urbit's
23mounted `%home` desk. You can run the following shell commands (*replacing your
24urbit's home desk path as necessary*):
26 $ git clone https://github.com/urbit/docs.git
27 $ cd ./docs/
28 $ cp -r ./docs* /path/to/your-urbit/home/web/
30Your Clay filesystem should acknowledge the newly added files.
32Lastly, if make sure you're serving your home desk's `web` directory to the web
33by running the following Dojo command:
35 ~your-urbit:dojo> |serve /=home=/web
37## Get started!
39And now your docs are live! View them at:
41 http://localhost:8080/~~/docs
43> If you're running multiple ships locally, your port number will be `8081`,
44 `8082`, and so on. Check your Dojo output for the correct local port of
45 your examples urbit, or view these at `https://your-urbit.urbit.org` over DNS
46 instead for live-network ships. You can also replace `localhost` with the IP
47 of your instance, if you're running your urbit in the cloud.
49## Building the docs with |static
51**note** This instructions are for use with the the [release-candidate branch](https://github.com/urbit/arvo/tree/release-candidate)
52of Arvo.
54Arvo comes with a built-in static site generator, which is very useful for
55exporting sites and pages built with udon, sail, html, markdown or some
56combination of these. Combinations like these docs that you're reading!
58In order to build the docs into a static site, do the following.
60Make sure that you've mounted your ship to your filesystem, but running the following
61in your Dojo.
63> ~ship:dojo>|mount /===
65Then, copy these docs into the pier of a booted ship. It is very important that
66copy the docs into the exact directory indicated in your pier.
68> $ cp -r . <ship-name>/home/web/static-site
70Now, run the static site generator on your urbit ship.
72> ~ship:dojo>|static
74You can now navigate to the output director and run a webserver to view your built docs.
76> $ cd <ship-name>/.urb/put/web/static-site
77> $ python -m SimpleHTTPServer
79Visit `localhost:8000` to see the built docs. Rerun `|static` to build docs and
80see changes.
82## Learn a lot, and have fun!
84People are always around on
85[Talk](https://urbit.org/docs/using/setup#-messaging-talk) and
86[Fora](https://fora.urbit.org/) to answer your questions. Help each other
87out, and don't hesitate if you have an idea for a docs improvement. We'd love if
88the docs themselves became an Urbit community project.
90## Contributing / Feedback
92Give us feedback [on Fora](https://fora.urbit.org/) on how we can make the
93docs better. Let us know about your ideas, requests, and/or problems and we'll
94try and get back to you quickly. Pull requests are more than welcome.