search

segullshairbutt / islamopedia-books

This is a helper repository of islamopedia to keep the backup of the books in plain text format.
1 stars 0 forks source link

Creating templates for a writer for getting started #1

Open segullshairbutt opened 2 months ago

segullshairbutt commented 2 months ago

As a writer I expect that there is a base book, that I can use as a template to start writing my own book. The book should have following details.

  1. TEMPLATES/book/info.json
  2. TEMPLATES/book/1/page.html, book/1/page.png
  3. TEMPLATES/base.html
  4. TEMPLATES/base.css
  5. TEMPLATES/README.md

Here first 2 files indicate the book structure. Later 2 are the template files that a writer can use to write a page and last one contains the details how someone can use these template files as benchmark.

  1. info.json: this file should contain the relevant possible detail that can be provided in our books. If we encounter something new while writing a book, this file should also be updated.
  2. page.html: it should be an example html page indicating all supported classes and tags in our markup. If we encounter something new while writing this file should also be updated.
  3. base.css: This file contains some styles that will be helpful for the writer to distinguish whether he is writing the correct markup or not. There should be contrasting styles for each element. If we encounter a new element/class, a new style should be added for that.
  4. README.md: This file contains all the relevant details of how to use these template files. Moreover, it can also have some recommendation for the tools or dev setup that will help the writer on the way.
segullshairbutt commented 1 month ago

See PR #5 for the development of this issue.