https://github.com/terasakisatoshi/mojimoji.jl

DemoCards.jl を使いたいんだ，でもねでもね．あのね．その・・・ね．．．（もじもじして恥ずかしがる様子）
https://github.com/terasakisatoshi/mojimoji.jl

Last synced: 3 days ago
JSON representation

DemoCards.jl を使いたいんだ，でもねでもね．あのね．その・・・ね．．．（もじもじして恥ずかしがる様子）

• Host: GitHub
• URL: https://github.com/terasakisatoshi/mojimoji.jl
• Owner: terasakisatoshi
• License: mit
• Created: 2023-02-10T09:57:16.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-10T11:52:29.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T12:41:05.804Z (about 1 month ago)
• Language: Dockerfile
• Homepage: https://terasakisatoshi.github.io/MojiMoji.jl/dev/
• Size: 137 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MojiMoji [![Build Status](https://github.com/terasakisatoshi/MojiMoji.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/terasakisatoshi/MojiMoji.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://terasakisatoshi.github.io/MojiMoji.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://terasakisatoshi.github.io/MojiMoji.jl/dev/)

# 概要

[DemoCards.jl](https://github.com/JuliaDocs/DemoCards.jl) を使うサンプルパッケージ. MojiMoji モジュールが特段何かをするわけではない. 響きが可愛いでしょ？

# Usage

Julia と LiveServer.jl をインストールする必要がある. 後者は Julia パッケージの一つである. `julia -e 'using Pkg; Pkg.add("LiveServer")'` とすれば導入できる.

```console

$ git clone https://github.com/terasakisatoshi/MojiMoji.jl.git

$ cd MojiMoji.jl

$ make web

```

`make web` は, `Makefile` を見ればわかるように, 下記を実行している:

```

julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); \

        Pkg.instantiate(); \

        include("docs/make.jl"); \

        using LiveServer; servedocs(host="0.0.0.0"); \

        '

```

# コンテナを使った場合

このリポジトリでは Docker, Docker Compose による実行方法も提供している. つまり，ローカル環境で Julia のセットアップが億劫な人向けである:

```console

$ git clone https://github.com/terasakisatoshi/MojiMoji.jl.git

$ cd MojiMoji.jl

$ make

$ docker-compose up web

```

下記のような出力を得たら `http://0.0.0.0:8000/` にアクセスする.

```

mojimojijl-packagedocs  | [ Info: Listening on: 0.0.0.0:8000, thread id: 1

mojimojijl-packagedocs  | ✓ LiveServer listening on http://0.0.0.0:8000/ ...

mojimojijl-packagedocs  |   (use CTRL+C to shut down)

```