Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support for mdbook version of the tutorials #773

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/tokio/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
25 changes: 25 additions & 0 deletions docs/tokio/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Summary

# Tokio

- [Tutorial](./tutorial/index.md)
- [Setup](./tutorial/setup.md)
- [Hello Tokio](./tutorial/hello-tokio.md)
- [Spawning](./tutorial/spawning.md)
- [Shared state](./tutorial/shared-state.md)
- [Channels](./tutorial/channels.md)
- [I/O](./tutorial/io.md)
- [Framing](./tutorial/framing.md)
- [Async in depth](./tutorial/async.md)
- [Select](./tutorial/select.md)
- [Streams](./tutorial/streams.md)

- [Topics](./topics/index.md)
- [Bridging with sync code](./topics/bridging.md)
- [Graceful Shutdown](./topics/shutdown.md)
- [Getting started with Tracing](./topics/tracing.md)
- [Next steps with Tracing](./topics/tracing-next-steps.md)
- [Unit Testing](./topics/testing.md)

- [Glossary](./glossary.md)
- [API Docs]()
15 changes: 15 additions & 0 deletions docs/tokio/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[book]
authors = []
language = "en"
multilingual = false
src = "./"
title = "Tokio"

[output.html]
git-repository-icon = "fa-github"
git-repository-url = "https://github.com/tokio-rs/tokio"
edit-url-template = "https://github.com/tokio-rs/website/tree/master/content/tokio/{path}"

[output.html.playground]
editable = false
runnable = false
3 changes: 3 additions & 0 deletions docs/tokio/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Glossary

{{#include ../../content/tokio/glossary.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/topics/bridging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Bridging with sync code

{{#include ../../../content/tokio/topics/bridging.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/topics/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Topics

{{#include ../../../content/tokio/topics/index.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/topics/shutdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Graceful Shutdown

{{#include ../../../content/tokio/topics/shutdown.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/topics/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Unit Testing

{{#include ../../../content/tokio/topics/testing.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/topics/tracing-next-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Next steps with Tracing

{{#include ../../../content/tokio/topics/tracing-next-steps.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/topics/tracing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Getting started with Tracing

{{#include ../../../content/tokio/topics/tracing.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/async.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Async in depth

{{#include ../../../content/tokio/tutorial/async.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/channels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Channels

{{#include ../../../content/tokio/tutorial/channels.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/framing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Framing

{{#include ../../../content/tokio/tutorial/framing.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/hello-tokio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Hello Tokio

{{#include ../../../content/tokio/tutorial/hello-tokio.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Tutorial

{{#include ../../../content/tokio/tutorial/index.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/io.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# I/O

{{#include ../../../content/tokio/tutorial/io.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/select.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Select

{{#include ../../../content/tokio/tutorial/select.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Setup

{{#include ../../../content/tokio/tutorial/setup.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/shared-state.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Shared state

{{#include ../../../content/tokio/tutorial/shared-state.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/spawning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Spawning

{{#include ../../../content/tokio/tutorial/spawning.md:5:}}
3 changes: 3 additions & 0 deletions docs/tokio/tutorial/streams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Streams

{{#include ../../../content/tokio/tutorial/streams.md:5:}}
Loading