mkdocs.yml

site_name: Manual for celseq2
site_url: https://yanailab.github.io/celseq2/
site_description: 'User manual for celseq2, a Python framework for processing CEL-Seq2 data'
site_author: 'Yun Yan'

repo_name: yanailab/celseq2
repo_url: https://github.com/yanailab/celseq2
edit_uri: edit/master/docs/

copyright: 'Copyright &copy 2017 New York University'
theme:
  name: 'material'
  feature:
    tabs: false
  palette:
    primary: 'deep purple'
    accent: 'purple'
  logo:
      icon: 'home'
  font:
    text: 'Open Sans'
    #   code: 'Robote Mono'
extra:
  social:
    - type: 'github'
      link: https://github.com/yanailab
    - type: 'link'
      link: https://yanailab.org


# extra_css:
#     - css/extra.css

markdown_extensions:
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.betterem(smart_enable=all)
  - fontawesome_markdown
  - toc(permalink=true)
  - admonition
  - codehilite
  - footnotes

pages:
  - Home: 'index.md'
  - User Guide:
    - 'Setup configuration': 'user_guide/setup_config.md'
    - 'Specify experiment table': 'user_guide/experiment_table.md'
    - 'Launch pipeline': 'user_guide/launch_pipeline.md'
    - 'Storage management': 'user_guide/storage.md'
  - About:
    - 'Reproducibility': 'about/reproducibility.md'
    - 'User experience': 'about/user_friendly.md'
    - 'Performance': 'about/performance.md'
    - 'Support other methods': 'about/support_others.md'
    - 'Release note': 'about/release_note.md'
    - 'License': 'about/LICENSE.md'
  - FAQ: 'faq.md'