Skip to content

Commit 83917d2

Browse files
committed
update hugo and docapi theme
1 parent 4c2eb64 commit 83917d2

107 files changed

Lines changed: 8396 additions & 2659 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.DS_Store
22
public
3+
node_modules/

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,7 @@ now enter [`localhost:1313`](http://localhost:1313) in the address bar of your b
1616
### Html Version
1717
if you don't want to run site from source code and just want to see html version of this site, you can [download gh-pages branch](https://github.com/Text-Mining/docs/archive/gh-pages.zip)
1818

19+
---
20+
21+
> For more information, please visit [hugo quick start page](https://gohugo.io/getting-started/quick-start/ "Create a Hugo site using the beautiful Ananke theme") and [this document](https://github.com/eine/issue-runner/blob/master/.github/workflows/doc.yml).
22+

archetypes/default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "{{ replace .TranslationBaseName "-" " " | title }}"
2+
title: "{{ replace .Name "-" " " | title }}"
33
date: {{ .Date }}
44
draft: true
55
---
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
body, html, h1, h2, h3, h4, h5, h6 {
2+
font-family: Vazir !important;
3+
}
4+
5+
.content {
6+
p, aside {
7+
direction: rtl;
8+
text-align: right !important;
9+
}
10+
}
11+
12+
h1, h2, h3, h4, h5, h6 {
13+
direction: rtl;
14+
text-align: right !important;
15+
}
16+
17+
.tocify-wrapper {
18+
.tocify-item > a {
19+
direction: rtl;
20+
text-align: right !important;
21+
}
22+
23+
.toc-footer {
24+
li, a {
25+
direction: rtl;
26+
text-align: right !important;
27+
}
28+
}
29+
}
30+
31+
.content table {
32+
direction: rtl;
33+
text-align: right !important;
34+
35+
td, th {
36+
direction: rtl;
37+
text-align: right !important;
38+
}
39+
}
40+
41+
ul li {
42+
direction: rtl;
43+
text-align: right !important;
44+
}
45+
46+
.content {
47+
code, p code {
48+
direction: ltr;
49+
text-align: left;
50+
display: inline-block;
51+
}
52+
53+
table {
54+
overflow: inherit;
55+
}
56+
57+
p {
58+
line-height: 2em;
59+
}
60+
}

config.toml

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
theme = "docuapi"
21
languageCode = "fa-ir"
32
baseurl = "http://docs.text-mining.ir/"
43
title = "مستندات سرویس متن‌کاوی فارسی‌یار"
4+
theme = "docuapi"
55

66
# Code higlighting settings
77
pygmentsCodefences = true
@@ -13,6 +13,19 @@ pygmentsUseClasses = true
1313

1414
defaultContentLanguage = "fa"
1515

16+
[markup]
17+
[markup.goldmark]
18+
[markup.goldmark.parser]
19+
autoHeadingIDType = "github-ascii"
20+
[markup.goldmark.renderer]
21+
unsafe = true
22+
23+
[module]
24+
[module.hugoVersion]
25+
[[module.imports]]
26+
# We include the theme by "../.." above, but we need one module import for Hugo to detect us as a Hugo Module.
27+
path="github.com/bep/empty-hugo-module"
28+
1629
[params]
1730
search = false
1831

content/errors.md

100755100644
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ API متن‌کاوی به صورت کلی خطاهای زیر را برمی‌
1616
کد خطا | معنا
1717
---------- | -------
1818
400 | Bad Request -- درخواست نامعتبر به دلیل اشتباه در پارامترهای ورودی
19-
401 | Unauthorized -- درخواست شما احراز هویت نشده است. ممکن است به دلیل کلید API اشتباه یا منقضی باشد
19+
401 | Unauthorized -- درخواست شما احراز هویت نشده است. ممکن است به دلیل کلید API اشتباه یا منقضی شده (پایان دوره اعتبار مشخص شده در پنل توسعه‌دهندگان) یا توکن منقضی شده (چون توکن بعد از نیم ساعت منقضی می‌شود) باشد
2020
404 | Not Found -- آدرس درخواستی شما در لیست توابع API وجود ندارد
2121
500 | Internal Server Error -- خطا در سرور API

content/main.md

100755100644
Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ title: API Reference
77

88
> دریافت کلید API برنامه‌نویسان برای استفاده از امکانات از سایت [https://app.text-mining.ir](https://app.text-mining.ir) است.
99
10-
> استفاده‌کنندگان رایگان از API، حداکثر مجاز به ارسال روزی ۱۰۰ درخواست (فراخوانی) و در هر ثانیه یک درخواست و هر فراخوانی (درخواست) با طول ورودی متنی کمتر از 3000 کاراکتر (یونیکد) یا 6000 هزاربایت می‌باشند.
10+
> استفاده‌کنندگان رایگان از API، حداکثر مجاز به ارسال روزی ۱۰۰۰ [واحد](https://text-mining.ir/pricing#C2) درخواست (فراخوانی) و در هر ثانیه یک درخواست هستند.
11+
12+
> لیست کامل توابع API در قالب <code>swagger</code> در آدرس [https://api.text-mining.ir](https://api.text-mining.ir) در دسترس است.
1113
1214
به مستندات سرویس [متن‌کاوی فارسی‌یار](https://text-mining.ir) خوش آمدید.
1315

@@ -17,11 +19,11 @@ title: API Reference
1719
برای اطلاع از میزان محدودیت‌های نسخه رایگان API به <a href="https://text-mining.ir/terms">صفحه قوانین و مقررات</a> مراجعه فرمایید.
1820
</aside>
1921

20-
**توجه: برای استفاده از هر یک از امکانات وب سرویس متن‌کاوی باید کلید API داشته باشید**
21-
همچنین برای جلوگیری از تکرار در نمونه کد بعضی از زبان‌ها مانند پایتون، بعضی از توابع پایه‌ای مثل تابع فراخوانی Rest API یا دریافت توکن تنها یک بار اضافه شده‌اند
22+
**توجه: برای استفاده از هر یک از امکانات وب سرویس متن‌کاوی باید کلید API داشته باشید.**
23+
همچنین برای جلوگیری از تکرار در نمونه کد بعضی از زبان‌ها مانند پایتون، بعضی از توابع پایه‌ای مثل تابع فراخوانی Rest API یا دریافت توکن تنها یک بار اضافه شده‌اند.
2224

2325
<aside class="success">
24-
لیست کامل توابع API در قالب <code>swagger</code> در <a href="https://api.text-mining.ir">https://api.text-mining.ir</a> در دسترس است
26+
<a href="https://aparat.com/v/BDcQV" target="_blank">این ویدئو در 5 دقیقه</a> نحوه دریافت کلید API و استفاده از آن را توضیح میدهد و جهت استفاده از سرویس‌های پردازش متن فارسی‌یار در سایر زبان‌های برنامه‌نویسی <a href="https://aparat.com/v/sxvF4" target="_blank">این ویدئوی 3 دقیقه‌ای</a> را تماشا بفرمایید.
2527
</aside>
2628

2729
# احراز هویت
@@ -1642,7 +1644,7 @@ try {
16421644

16431645
```
16441646

1645-
> خروجی مثال کد بالا: ["احسان","نیکی کردن","نیکوکاری","بخشش","نیکی","خوبی","نیکویی","انعام","نکویی","اکرام","صنع","فضل","لطف","منت","نزل","نعمت","نیکی_کردن","احسان (نام)","احسان_(نام)"]
1647+
> خروجی مثال کد بالا: ["احسان","نیکی کردن","نیکوکاری", "بخشش","نیکی","خوبی","نیکویی","انعام", "نکویی","اکرام","صنع","فضل","لطف", "منت","نزل","نعمت","نیکی_کردن", "احسان (نام)","احسان_(نام)"]
16461648
16471649
### آدرس و نوع تابع وب‌سرویس
16481650

@@ -2233,7 +2235,7 @@ try {
22332235
22342236
### آدرس و نوع تابع وب‌سرویس
22352237

2236-
`POST https://api.text-mining.ir/api/SentimentAnalyzer/SentimentClassifier`
2238+
`POST https://api.text-mining.ir/api/SentimentAnalyzer/SentimentClassifier2`
22372239

22382240
### مدل دریافتی به عنوان پارامتر
22392241

go.mod

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
module github.com/bep/docuapi
2+
3+
go 1.12
4+
5+
require (
6+
github.com/bep/empty-hugo-module v1.0.0 // indirect
7+
github.com/jquery/jquery-dist v0.0.0-20210302171154-e786e3d9707f // indirect
8+
github.com/olivernn/lunr.js v2.3.9+incompatible // indirect
9+
github.com/slatedocs/slate v2.10.0+incompatible // indirect
10+
)

go.sum

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
github.com/bep/empty-hugo-module v1.0.0 h1:aYc9RWea644CdYjg9zCy8nkVF4KjC3fwhUTvvcXXg8s=
2+
github.com/bep/empty-hugo-module v1.0.0/go.mod h1:whohinbSjMoFi/Skivj9kvdPs1tEgzYpZ4rXoQk/0/I=
3+
github.com/jquery/jquery-dist v0.0.0-20210302171154-e786e3d9707f h1:VrcFwwDo/nKErNIKmp//iOGu7DlRkBTeW//hN7tl7SU=
4+
github.com/jquery/jquery-dist v0.0.0-20210302171154-e786e3d9707f/go.mod h1:/lTfttEqFU0GWTaOOMIeNTzLGQ7yTIgyzjtkS/pYIoc=
5+
github.com/olivernn/lunr.js v2.3.9+incompatible h1:eH8iBnjlR4mwlYDdNuqy9PCNLjp2bEs6aoNnTSaccx0=
6+
github.com/olivernn/lunr.js v2.3.9+incompatible/go.mod h1:yEkQ1DUSMtNsn8n2CqvQXZd0ErWPEG8g9QRmblR+KS8=
7+
github.com/slatedocs/slate v2.9.2+incompatible h1:PnIMTR1S7pE6tImIjF6ny9UaRrt6fukM93lwUwJPtjw=
8+
github.com/slatedocs/slate v2.9.2+incompatible/go.mod h1:n698aXLkExWIlF7prJey0Kq6wlKIKvj/stVb5oouZDM=
9+
github.com/slatedocs/slate v2.10.0+incompatible h1:BPn0BARr8FvB+Es1wlrtvzAZ4Mxvn/CfymyKFT3O7+0=
10+
github.com/slatedocs/slate v2.10.0+incompatible/go.mod h1:n698aXLkExWIlF7prJey0Kq6wlKIKvj/stVb5oouZDM=

layouts/partials/hook_head_end.html

100755100644
File mode changed.

0 commit comments

Comments
 (0)