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

WIP: Add Persian and English mkdocs #30

Draft
wants to merge 2 commits into
base: develop
Choose a base branch
from
Draft
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
4 changes: 4 additions & 0 deletions docs/en/data/github_sponsors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
sponsors:
- - login: cryptapi
avatarUrl: https://avatars.githubusercontent.com/u/44925437?u=61369138589bc7fee6c417f3fbd50fbd38286cc4&v=4
url: https://github.com/cryptapi
Comment on lines +1 to +4
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have sponsers!

546 changes: 546 additions & 0 deletions docs/en/data/people.yml

Large diffs are not rendered by default.

36 changes: 36 additions & 0 deletions docs/en/data/sponsors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
gold:
- url: https://cryptapi.io/
title: "CryptAPI: Your easy to use, secure and privacy oriented payment gateway."
img: https://fastapi.tiangolo.com/img/sponsors/cryptapi.svg
- url: https://platform.sh/try-it-now/?utm_source=fastapi-signup&utm_medium=banner&utm_campaign=FastAPI-signup-June-2023
title: "Build, run and scale your apps on a modern, reliable, and secure PaaS."
img: https://fastapi.tiangolo.com/img/sponsors/platform-sh.png
silver:
- url: https://www.deta.sh/?ref=fastapi
title: The launchpad for all your (team's) ideas
img: https://fastapi.tiangolo.com/img/sponsors/deta.svg
- url: https://training.talkpython.fm/fastapi-courses
title: FastAPI video courses on demand from people you trust
img: https://fastapi.tiangolo.com/img/sponsors/talkpython.png
- url: https://testdriven.io/courses/tdd-fastapi/
title: Learn to build high-quality web apps with best practices
img: https://fastapi.tiangolo.com/img/sponsors/testdriven.svg
- url: https://github.com/deepset-ai/haystack/
title: Build powerful search from composable, open source building blocks
img: https://fastapi.tiangolo.com/img/sponsors/haystack-fastapi.svg
- url: https://careers.powens.com/
title: Powens is hiring!
img: https://fastapi.tiangolo.com/img/sponsors/powens.png
- url: https://www.svix.com/
title: Svix - Webhooks as a service
img: https://fastapi.tiangolo.com/img/sponsors/svix.svg
- url: https://databento.com/
title: Pay as you go for market data
img: https://fastapi.tiangolo.com/img/sponsors/databento.svg
bronze:
- url: https://www.exoflare.com/open-source/?utm_source=FastAPI&utm_campaign=open_source
title: Biosecurity risk assessments made easy.
img: https://fastapi.tiangolo.com/img/sponsors/exoflare.png
- url: https://www.flint.sh
title: IT expertise, consulting and development by passionate people
img: https://fastapi.tiangolo.com/img/sponsors/flint.png
19 changes: 19 additions & 0 deletions docs/en/data/sponsors_badge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
logins:
- jina-ai
- deta
- investsuite
- mikeckennedy
- deepset-ai
- cryptapi
- xoflare
- DropbaseHQ
- VincentParedes
- BLUE-DEVIL1134
- ObliviousAI
- Doist
- nihpo
- svix
- armand-sauzay
- databento-bot
- nanram22
Comment on lines +1 to +18
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have sponsers

- Flint-company
1 change: 1 addition & 0 deletions docs/en/docs/advanced/customizing-engine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Customizing Engine
1 change: 1 addition & 0 deletions docs/en/docs/advanced/customizing-logging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Customizing Logging
1 change: 1 addition & 0 deletions docs/en/docs/advanced/customizing-parser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Customizing Parser
1 change: 1 addition & 0 deletions docs/en/docs/advanced/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Advanced guide
1 change: 1 addition & 0 deletions docs/en/docs/advanced/middleware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Middleware
146 changes: 146 additions & 0 deletions docs/en/docs/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
.termynal-comment {
color: #4a968f;
font-style: italic;
display: block;
}

.termy {
/* For right to left languages */
direction: ltr;
}

.termy [data-termynal] {
white-space: pre-wrap;
}

a.external-link {
/* For right to left languages */
direction: ltr;
display: inline-block;
}

a.external-link::after {
/* \00A0 is a non-breaking space
to make the mark be on the same line as the link
*/
content: "\00A0[↪]";
}

a.internal-link::after {
/* \00A0 is a non-breaking space
to make the mark be on the same line as the link
*/
content: "\00A0↪";
}

.shadow {
box-shadow: 5px 5px 10px #999;
}

/* Give space to lower icons so Gitter chat doesn't get on top of them */
.md-footer-meta {
padding-bottom: 2em;
}

.user-list {
display: flex;
flex-wrap: wrap;
margin-bottom: 2rem;
}

.user-list-center {
justify-content: space-evenly;
}

.user {
margin: 1em;
min-width: 7em;
}

.user .avatar-wrapper {
width: 80px;
height: 80px;
margin: 10px auto;
overflow: hidden;
border-radius: 50%;
position: relative;
}

.user .avatar-wrapper img {
position: absolute;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);
}

.user .title {
text-align: center;
}

.user .count {
font-size: 80%;
text-align: center;
}

a.announce-link:link,
a.announce-link:visited {
color: #fff;
}

a.announce-link:hover {
color: var(--md-accent-fg-color);
}

.announce-wrapper {
display: flex;
justify-content: space-between;
flex-wrap: wrap;
align-items: center;
}

.announce-wrapper div.item {
display: none;
}

.announce-wrapper .sponsor-badge {
display: block;
position: absolute;
top: -10px;
right: 0;
font-size: 0.5rem;
color: #999;
background-color: #666;
border-radius: 10px;
padding: 0 10px;
z-index: 10;
}

.announce-wrapper .sponsor-image {
display: block;
border-radius: 20px;
}

.announce-wrapper>div {
min-height: 40px;
display: flex;
align-items: center;
}

.twitter {
color: #00acee;
}

/* Right to left languages */
code {
direction: ltr;
display: inline-block;
}

.md-content__inner h1 {
direction: ltr !important;
}

.illustration {
margin-top: 2em;
margin-bottom: 2em;
}
109 changes: 109 additions & 0 deletions docs/en/docs/css/termynal.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
/**
* termynal.js
*
* @author Ines Montani <[email protected]>
* @version 0.0.1
* @license MIT
*/

:root {
--color-bg: #252a33;
--color-text: #eee;
--color-text-subtle: #a2a2a2;
}

[data-termynal] {
width: 750px;
max-width: 100%;
background: var(--color-bg);
color: var(--color-text);
/* font-size: 18px; */
font-size: 15px;
/* font-family: 'Fira Mono', Consolas, Menlo, Monaco, 'Courier New', Courier, monospace; */
font-family: 'Roboto Mono', 'Fira Mono', Consolas, Menlo, Monaco, 'Courier New', Courier, monospace;
border-radius: 4px;
padding: 75px 45px 35px;
position: relative;
-webkit-box-sizing: border-box;
box-sizing: border-box;
}

[data-termynal]:before {
content: '';
position: absolute;
top: 15px;
left: 15px;
display: inline-block;
width: 15px;
height: 15px;
border-radius: 50%;
/* A little hack to display the window buttons in one pseudo element. */
background: #d9515d;
-webkit-box-shadow: 25px 0 0 #f4c025, 50px 0 0 #3ec930;
box-shadow: 25px 0 0 #f4c025, 50px 0 0 #3ec930;
}

[data-termynal]:after {
content: 'bash';
position: absolute;
color: var(--color-text-subtle);
top: 5px;
left: 0;
width: 100%;
text-align: center;
}

a[data-terminal-control] {
text-align: right;
display: block;
color: #aebbff;
}

[data-ty] {
display: block;
line-height: 2;
}

[data-ty]:before {
/* Set up defaults and ensure empty lines are displayed. */
content: '';
display: inline-block;
vertical-align: middle;
}

[data-ty="input"]:before,
[data-ty-prompt]:before {
margin-right: 0.75em;
color: var(--color-text-subtle);
}

[data-ty="input"]:before {
content: '$';
}

[data-ty][data-ty-prompt]:before {
content: attr(data-ty-prompt);
}

[data-ty-cursor]:after {
content: attr(data-ty-cursor);
font-family: monospace;
margin-left: 0.5em;
-webkit-animation: blink 1s infinite;
animation: blink 1s infinite;
}


/* Cursor animation */

@-webkit-keyframes blink {
50% {
opacity: 0;
}
}

@keyframes blink {
50% {
opacity: 0;
}
}
9 changes: 9 additions & 0 deletions docs/en/docs/fastcrawler-people.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# FastCrawler People

FastAPI has an amazing community that welcomes people from all backgrounds.

## Creator - Maintainer

Hey! 👋

This is me:
5 changes: 5 additions & 0 deletions docs/en/docs/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Features

## FastCrawler features

**FastCrawler** gives you the following:
Binary file added docs/en/docs/img/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/docs/img/github-social-preview.png
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't use FastAPI logo

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading