PineDocs

Pinedocs

ファイルを表示するための高速で軽量のサイト。

ドキュメント、Wiki、例、メモ、ドキュメント、ギャラリー、ストレージなどに最適です。

---

Docker Hub |スクリーンショット|セットアップ|構成|スポンサー

---

https://imgur.com/a/15gq67xのスクリーンショットをご覧ください

スポンサー

このプロジェクトをアクティブに保つためにスポンサーまたは寄付を検討してください-https：//github.com/sponsors/xy2z

特徴

• データベースはありません。
• 建物はありません。
• 高速 - ajaxとキャッシュを使用します。
• Markdown、Plantext、HTML、コード、画像、SVG、GIF、MathJax、PDFS、オーディオ、小さなビデオをサポートしています。基本的に、ブラウザでレンダリングできるものは何でも。
• レスポンシブレイアウトとさまざまな配色（こちらのスクリーンショットを参照）
• 77を超えるテーマを持つ169を超える言語の構文強調表示。
• 構成（以下を参照）。
• ファイル内のクイックフィルタリング。
• 既存のファイルまたは既存のgitリポジトリをコンテンツとして使用します。
• ファイルは最初のビューの後にクライアント側にキャッシュされているため、即座にロードされます。
• 非表示フォルダー - 直接リンクからのみアクセスできます。
• ページごとのスクロール位置を覚えておいてください。

読み取り専用サイト

Pinedocsは読み取り専用です。つまり、ファイルのみを表示し、Pinedocsを介して編集できないことを意味します。これは、ユーザーログイン、リビジョンなどに代わるWikiの代替ではありません。これは基本的に、コンテンツディレクトリのすべてをレンダリングするシンプルなサイトです。そのため、コンテンツを変更するには、サーバー/PCのファイルを編集する必要があります。

設定

Docker

Dockerは、Pinedocsをセットアップする最も簡単な方法です。

docker-compose.yml

 version : ' 3 '

services :
  web :
    image : xy2z/pinedocs:1.2.5
    ports :
      - 3000:80
    volumes :
      - ./data:/data/pinedocs

docker-compose up -dを実行した後、 ./data/config/config.yaml config/config.yamlの構成を変更し、 ./data/files files dirにファイル（またはgitクローン）を追加できます。

ページをリロードすると、変更が影響を受けます - コンテナを再起動する必要はありません。

Docker

Altough Docker-Composeをお勧めします。純粋なDockerを使用することもできます。

docker run -itd -v "$PWD"/data:/data/pinedocs -p 3000:80 xy2z/pinedocs

詳細については、https：//hub.docker.com/r/xy2z/pinedocs/をご覧ください

手動セットアップ

要件

• PHP 8.0（ミニナム必須PHPバージョンはPHP 7.2.5です）
• 依存関係の作曲家。
• Webサーバー（apache2、nginxなど）

セットアップガイド

1. 最新リリースをダウンロードするか、 git cloneを実行します
2. 依存関係を取得するために、ルートにcomposer install実行します。
3. WebサーバーをPineDocs/public dirにセットアップします（ php -S localhost:89 -t publicのために公開されます）
4. （オプション）設定を変更するためのfile config/config-example.yamlの名前をconfig/config.yamlに変更します（以下を参照）
5. （オプション）MathJaxの設定を変更するためのconfig/mathjax-example.js名前をconfig/mathjax.jsに変更します（以下を参照）
6. （オプション）dockerを使用してJavaScriptをカスタマイズするときにファイルconfig/custom.jsを変更する
7. （オプション）Dockerを使用してCSSをカスタマイズするときにファイルconfig/custom.cssを変更する

構成

ニーズに合わせてconfig/config.yamlファイルを編集してください。

config/mathjax.jsファイルを編集して、mathjaxを構成できます。

設定

• title （文字列）ロゴ、タブ、ブックマークで使用されるサイトのタイトル。

• content_dir （文字列）使用する監督へのパス。デフォルトはPinedocs/ content/ dirです。

• index （文字列）インデックスファイルへの相対パス。デフォルトは、 index.md 、 index.html 、 index.txt 、 indexの配列です。

• layout （文字列）利用可能なレイアウト： default 、 wiki 。

• color_scheme （String）利用可能な配色： pinedocs 、 simplistic 、 simplistic-dark 、 twilight 。

• highlight_theme （文字列）コードに使用するテーマ。 https://highlightjs.org/static/demo/のリストを参照してください

• code_transparent_bg （bool） trueの場合、すべてがハイライトテーマを使用します。 falseの場合、背景は透明になります。

• open_dirs （int | string）ページの読み込みでopnedするべき監督のレベル数。 all使用してすべての監督を開きます。

• render_footer （bool）メニューフッターをレンダリングしますか？

• exclude_filesファイルまたはdireのリストを除外します。形式が /regex /iである場合、正規表現をサポートします。

• show_file_extension （bool）ファイル拡張子を表示します。デフォルトはtrueです。

• menu_link_format （string）値：デフォルト、ucfirst、ucwords、大文字、小文字。

• render_max_file_size （float）最大ファイルサイズ（MB）をレンダリングします。ファイルが大きい場合は、ダウンロードリンクが表示されます。デフォルトは50です。

• font_family （string）メニューとコンテンツに使用されるフォント。デフォルトはTahomaです。

• font_size （文字列）メニューとコンテンツのフォントサイズ。デフォルトは15pxです。

• no_extension_markdown （bool）は、マークダウンとして拡張機能なしでファイルをレンダリングします。たとえば、 README 。デフォルトはtrue 。

• break_code_blocks （bool）は、水平方向にスクロールするのではなく、複数の行でコードブロックを破壊します。デフォルトのfalse 。

• hide_folders_in_navigation （array）フロントエンドナビゲーションから隠すためのフォルダーのリスト。ケース非感受性。デフォルトはなしです。

• enable_mathjax （bool）enable mathjax。 mathjax.jsが機能するようにする必要があります。デフォルトはfalseです。

ライセンス

GNU GPLV3。 license.txtを参照してください