use rst for index

pull/7/head
yann300 7 years ago
parent 59a09fb751
commit 5a8112d8d3
  1. 2
      docs/conf.py
  2. 48
      docs/index.md
  3. 68
      docs/index.rst

@ -42,7 +42,7 @@ templates_path = ['_templates']
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = ['.md']
source_suffix = ['.rst', '.md']
# The encoding of source files.
#source_encoding = 'utf-8-sig'

@ -1,48 +0,0 @@
Welcome to Remix documentation!
===============================
Remix is a powerful, open source tool that helps you write Solidity contracts straight from the browser.
Written in Javascript, Remix supports both usage in the browser or locally.
Remix also supports testing, debugging and deploying of smart contracts and much more.
Our Remix project with all its features is available
at `http://remix.ethereum.org` and more information can be found in these
docs. Our tool is available at `our GitHub repository
<https://github.com/ethereum/remix-id>`__.
This set of documents covers instructions on how to use Remix and some tutorials to help you get started.
## Quick start
* [Solidity Editor](solidity_editor.md)
* [Compile Tab](compile_tab.md)
* [Quick start with JavaScript VM](quickstart_javascript_vm.md)
* [Settings](settings_tab.md)
## Deploy and test
* [Run tab](run_tab.md)
* [Interact with contract](udapp.md)
## Other remix features
* [File explorer](file_explorer.md)
* [Debugger tab](debugger_tab.md)
* [Analysis tab](analysis_tab.md)
* [Terminal](terminal.md)
## Tutorials and workshops
* [Workshop building smart contracts](workshop_Building_smart_contracts_with_Remix.md)
* [Use Remix IDE with local files](tutorial_connect_remix_with_your_filesystem.md)
* [How to debug a transaction](tutorial_debug.md)
* [How to import solidity file](tutorial_import.md)
* [How to use Remix IDE in Mist](tutorial_mist.md)
## How to contibute
* [Contribution guide](code_contribution_guide.md)
* [Support tab](support_tab.md)
* [Support chat](support.md)

@ -0,0 +1,68 @@
Welcome to Remix documentation!
===============================
Remix is a powerful, open source tool that helps you write Solidity contracts straight from the browser.
Written in Javascript, Remix supports both usage in the browser or locally.
Remix also supports testing, debugging and deploying of smart contracts and much more.
Our Remix project with all its features is available
at `http://remix.ethereum.org` and more information can be found in these
docs. Our tool is available at `our GitHub repository
<https://github.com/ethereum/remix-id>`__.
This set of documents covers instructions on how to use Remix and some tutorials to help you get started.
.. quick-start:
.. toctree::
:maxdepth: 2
:caption: Quick start
solidity_editor
compile_tab
quickstart_javascript_vm
settings_tab
.. deploy and test:
.. toctree::
:maxdepth: 2
:caption: Deploy and test
run_tab
udapp
.. _other-remix-features:
.. toctree::
:maxdepth: 2
:caption: Other Remix features
file_explorer
debugger_tab
analysis_tab
terminal
.. _tutorials and workshops:
.. toctree::
:maxdepth: 2
:caption: Tutorials and workshops
workshop_Building_smart_contracts_with_Remix
tutorial_connect_remix_with_your_filesystem
tutorial_debug
tutorial_import
tutorial_mist
.. _code-contribution-guide:
.. toctree::
:maxdepth: 2
:caption: Code contribution guide
code_contribution_guide
support
support_tab
Loading…
Cancel
Save