Docs and Guides for Mailsac, the Friendliest Disposable Email API
Switch branches/tags
Nothing to show
Clone or download
mjmayer Merge pull request #2 from mailsac/new_colors
Update RTD with new logo and color scheme
Latest commit 00b424c Dec 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_static Update RTD with new logo and color scheme Dec 10, 2018
_templates Update RTD with new logo and color scheme Dec 10, 2018
about Update RTD with new logo and color scheme Dec 10, 2018
api_examples Update verify_email_address.rst Oct 24, 2018
getting_started Update checkmail.rst Oct 24, 2018
services link to websockets from services intro Oct 24, 2018
websocket_examples Update receive-mail.rst Oct 24, 2018
.editorconfig Initial commit: email validation, downloading attachments Mar 30, 2018
.gitignore Change theme to sphinx_rtd_theme Apr 6, 2018
LICENSE Add readme and license Oct 22, 2018
Makefile Initial commit using restructured text Apr 4, 2018
README.md How to view outputted docs Oct 23, 2018
conf.py Merge branch 'readthedocs' of github.com:mailsac/mailsac-examples int… Oct 23, 2018
index.rst Merge branch 'readthedocs' of https://github.com/mailsac/mailsac-exam… Oct 23, 2018
list-attachments-and-download-them.js adds usage for all api examples and getting started instructions in t… Mar 30, 2018
make.bat Initial commit using restructured text Apr 4, 2018
package-lock.json Initial commit: email validation, downloading attachments Mar 30, 2018
package.json Initial commit: email validation, downloading attachments Mar 30, 2018
validate-multiple-emails.js adds usage for all api examples and getting started instructions in t… Mar 30, 2018
validate-single-email.js adds usage for all api examples and getting started instructions in t… Mar 30, 2018

README.md

Mailsac-Examples

This repository is the documentation for Mailsac. It includes examples, service information, privacy policy, and terms of services.

Build Instructions

These documents are published to docs.mailsac.com, they can be built locally for testing purposes.

  1. Clone this repo git clone https://github.com/mailsac/mailsac-examples.git

  2. Install sphinx pip install Sphinx pip install sphinx_rtd_theme

  3. Change directories to the cloned repo cd mailsac-examples

  4. Run build script make html

  5. Build results can be found in _build/html/

  6. Optional - run a server to view the html output. npm install http-server -g http-server _build/html

Copyright © 2018 by Michael Mayer and Jeff Parrish